Learn R Programming

⚠️There's a newer version (1.26.0) of this package.Take me there.

R.oo (version 1.11.7)

R object-oriented programming with or without references

Description

Methods and classes for object-oriented programming in R with or without references. Large effort has been made on making definition of methods as simple as possible with a minimum of maintenance for package developers. The package has been developed since 2001 and is now considered very stable. This is a cross-platform package implemented in pure R that defines standard S3 classes without any tricks.

Copy Link

Version

Install

install.packages('R.oo')

Monthly Downloads

172,478

Version

1.11.7

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

January 15th, 2013

Functions in R.oo (1.11.7)

compile.Rdoc

Compile source code files containing Rdoc comments into Rd files
DOLLAR< -.Class

Makes the fields and methods of an Class assignable via the $<- and the [[<- operator
as.character.RccViolationException

Gets a string representing of the RCC violation
DOLLAR< -.Object

Makes the fields and methods of an Object assignable via the $<- and the [[<- operator
as.character.Package

Gets a string representation of this package
clearCache.Object

Clear fields that are defined to have cached values
getBundle.Package

Gets the Bundle that this package might belong to
declaration.Rdoc

Gets the class declaration
abort

Aborts the current expression call
charToInt

Converts a vector of ASCII characters into a vector of integers
getDescription.Package

Gets the description of the package
R.oo-package

Package R.oo
hasField.Object

Checks if a field exists or not
createManPath.Rdoc

Creates the directory where the Rd files should be saved
escapeRdFilename.Rdoc

Escape non-valid characters in a filename
Class

The Class class describes an Object class
getInstantiationTime.BasicObject

Gets the time when the object was instantiated
ll.Object

Generates a list of informative properties of all members of an Object
gc.Object

Clear cached fields and calls the garbage collector
getFields.Object

Returns the field names of an Object
print.Exception

Prints the Exception
showHowToCite.Package

Show the HOWTOCITE file of this package
as.character.Object

Gets a character string representing the object
getCalls.Exception

Gets the active calls saved when the exception was created
hashCode.Object

Gets a hash code for the Object
as.character.Interface

Gets a character string representing the Interface
novirtual.Object

Returns a reference to the same Object with virtual fields turned off
getStackTrace.Exception

Gets the stack trace saved when the exception was created
getKnownSubclasses.classRepresentation

Gets the known subclasses
DOLLAR.Object

Makes the fields and methods of an Object accessable via the $ and the [[ operator
methodsInheritedFrom.Rdoc

Gets all methods inherited from a class in Rd format
update.Package

Updates the package is a newer version is available
BasicObject

A root class like Object but without references
clearLookupCache.Object

Clear internal fields used for faster lookup
Exception

The Exception class to be thrown and caught
Non-documented objects

Non-documented objects
as.character.BasicObject

Gets a character string representing the object
getMessage.Exception

Gets the message of the Exception
getSuperclasses.classRepresentation

Gets the superclasses
isOlderThan.Package

Checks if the package is older than a given version
Package

The Package class provides methods for accessing package information
DOLLAR< -.BasicObject

Makes the fields and methods of an BasicObject assignable via the $<- and the [[<- operator
getManPath.Rdoc

Gets the path to the directory where the Rd files will be saved
DOLLAR.BasicObject

Makes the fields and methods of an BasicObject accessable via the $ and the [[ operator
getClasses.Package

Gets all classes of a package
Object

The root class that every class must inherit from
getVersion.Package

Gets the version of this package
detach.Object

Detach an Object from the R search path
getFields.Class

Returns the field names of a class
RccViolationException

An RccViolationException indicates a violation of the R Coding Conventions (RCC)
objectSize.BasicObject

Gets the size of the BasicObject in bytes
getDetails.Class

Lists the fields and methods of a class
getWhen.Exception

Gets the time when the Exception was created
getPackageNameOf.Rdoc

Gets the package of a method or an object
detach.BasicObject

Detach an BasicObject from the R search path
setManPath.Rdoc

Sets the path to the directory where the Rd files should be saved
getNameFormat.Rdoc

Gets the current name format
equals.BasicObject

Compares an object with another
extend.BasicObject

Extends another class
isKeyword.Rdoc

Checks if a word is a Rd keyword
forName.Class

Gets a Class object by a name of a class
getChangeLog.Package

Gets the change log of this package
getStaticInstance.Class

Gets the static instance of this class
getContribUrl.Package

Gets the URL(s) from where this package can be installed
argsToString.Class

Gets the arguments of a function as a character string
getName.Class

Gets the name of the class
getRdHierarchy.Class

Gets the class hierarchy in Rd format
getStaticInstance.Object

Gets the static instance of this objects class
getDate.Package

Gets the date when package was build
getExamplePath.Package

Gets the path to the example (R-ex/) directory of this package
getRccUrl.RccViolationException

Static method to get a URL where the RCC can be found
getLastException.Exception

Static method to get the last Exception thrown
throw

Throws an Exception
getDocPath.Package

Gets the path to the accompanying documentation (doc/) directory of this package
createName.Rdoc

Creates a class-method name
load.Object

Static method to load an Object from a file or a connection
getUsage.Rdoc

Gets the usage of a method
isStatic.Class

Checks if a class is static or not
getStackTraceString.Exception

Gets the stack trace as a string
getEnvironment.Object

Gets the environment of this object
getMessage.InternalErrorException

Gets the message of the exception
getPath.Package

Gets the library (system) path to this package
hasField.BasicObject

Checks if a field exists or not
getSuperclasses.Class

Gets the super classes of this class
getKeywords.Rdoc

Gets the keywords defined in R with descriptions
equals.Object

Compares an object with another
getLicense.Package

Gets the License of this package
check.Rdoc

Checks the compiled Rd files
as.character.RdocException

Gets a character string representing of the RdocException
.makeObjectFinalizer

Creates a standalone finalizer function for Object
setNameFormat.Rdoc

Sets the current name format
isBeingCreated.Class

Checks if a class is currently being initiated initiated
getPackage.Class

Gets the package to which the class belongs
attachLocally.Object

Attaches an Object locally to an environment
trim

Converts to a string and removes leading and trailing whitespace
getInternalAddress.Object

Gets the memory location where the Object resides
save.Object

Saves an Object to a file or a connection
getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format
getName.Package

Gets the name of this package
getPackage.InternalErrorException

Gets the suspicious package likely to contain an error
objectSize.environment

Gets the size of an environment in bytes
extend.Object

Extends another class
getDevelUrl.Package

Gets the URL(s) from where the developers version of this package can be installed
isProtected.Class

Checks if a class is defined protected or not
getAuthor.Package

Gets the Author of this package
getBundlePackages.Package

Gets the names of the other packages that is in the same bundle as this package
isDeprecated.Class

Checks if a class is deprecated or not
getRdDeclaration.Class

Gets the class declaraction in Rd format
startupMessage.Package

Generates a 'package successfully loaded' package startup message
getRdTitle.Rdoc

Extracts the title string of a Rd file
getFields.Interface

Returns NULL
hashCode.BasicObject

Gets a hash code for the object
isReferable.BasicObject

Checks if the object is referable or not
getFields.BasicObject

Returns the field names of an BasicObject
getRdMethods.Class

Gets the methods of a class in Rd format
isVisible.Rdoc

Checks if a member is visible given its modifiers
getEnvironment.Package

Gets the environment of a loaded package
isPrivate.Class

Checks if a class is defined private or not
typeOfClass

Gets the type of a class (S3 or S4)
isLoaded.Package

Checks if the package is installed on the search path or not
hierarchy.Rdoc

Gets the class hierarchy
ASCII

8-bit ASCII table
getKnownSubclasses.Class

Gets all subclasses that are currently loaded
InternalErrorException

InternalErrorException represents internal errors
print.BasicObject

Prints an BasicObject
as.character.Exception

Gets a character string representing of the Exception
attach.BasicObject

Attach an BasicObject to the R search path
Rdoc

Class for converting Rdoc comments to Rd files
getName.environment

Gets the name of an environment
getDescriptionFile.Package

Gets the description file of this package
setConstructorS3

Defines a class in S3/UseMethod style
getClassS4Usage.Rdoc

Gets the usage of a S4 class
clone.Object

Clones an Object
extend

Extends a object
objectSize.Object

Gets the size of the Object in bytes
objectSize

Gets the size of the object in bytes
getMethods.Class

Returns the method names of class and its super classes
ll.Package

Generates a list of informative properties of all members of the package
getPosition.Package

Gets the search path position of the package
uses.Interface

Specifies that an object uses this Interface
print.Object

Prints an Object
getHowToCite.Package

Gets the howToCite of this package
getSource.RdocException

Gets the source of the exception
isReferable.Object

Checks if the object is referable or not
showChangeLog.Package

Show the change log of this package
getTitle.Package

Gets the Title of this package
extend.Interface

Extends another Interface class
DOLLAR.Class

Makes the fields and methods of an Class accessable via the $ and the [[ operator
load.Package

Loads a package
equals

Compares an object with another
newInstance.Class

Creates a new instance of this class
intToChar

Converts a vector of integers into a vector of ASCII characters
staticCode.Object

Method that will be call each time a new instance of a class is created
isPublic.Class

Checks if a class is defined public or not
getUrl.Package

Gets the URL of this package
getMaintainer.Package

Gets the Maintainer of this package
throw.error

Throws (rethrows) an object of class 'error'
finalize.Object

Finalizer methods called when object is clean out
registerFinalizer.Object

Registers a finalizer hook for the object
dimension

Gets the dimension of the object
attach.Object

Attaches an Object to the R search path
unload.Package

Unloads a package
Interface

The Interface class
print.Interface

Prints an Interface
hashCode

Gets an integer hashcoded for R objects
RdocException

RdocException are thrown by the Rdoc compiler
getConstructorS3

Get a constructor method
showContents.Package

Show the CONTENTS file of this package
ll

Generates a list of informative properties of all members of an environment
throw.Exception

Throws an Exception that can be caught
getRdMethods.classRepresentation

Gets the methods in Rd format
showDescriptionFile.Package

Show the DESCRIPTION file of this package
getRdDeclaration.classRepresentation

Gets the class declaration in Rd format
isAbstract.Class

Checks if a class is abstract or not
newInstance.BasicObject

Creates a new instance of the same class as this object
print.Class

Prints detailed information about the class and its fields and methods
printStackTrace.Exception

Prints the stack trace saved when the exception was created
getFieldModifiers.Object

Gets all types of field modifiers
as.character.Class

Returns a short string describing the class
argsToString.Rdoc

Gets the arguments signature of a function
getContents.Package

Gets the contents of this package
getDataPath.Package

Gets the path to the data (data/) directory of this package
getInstantiationTime.Object

Gets the time when the object was instantiated
newInstance.Object

Creates a new instance of the same class as this object