R.oo: R Object-Oriented Programming with or without References
Version 1.21.0

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.

AuthorHenrik Bengtsson [aut, cre, cph]
Date of publication2016-11-01 00:03:19
MaintainerHenrik Bengtsson <henrikb@braju.com>
LicenseLGPL (>= 2.1)
Version1.21.0
URL https://github.com/HenrikBengtsson/R.oo
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("R.oo")

Getting started

Package overview

Popular man pages

ASCII: 8-bit ASCII table
charToInt: Converts a vector of ASCII characters into a vector of...
compile.Rdoc: Compile source code files containing Rdoc comments into Rd...
createName.Rdoc: Creates a class-method name
escapeRdFilename.Rdoc: Escape non-valid characters in a filename
getRccUrl.RccViolationException: Static method to get a URL where the RCC can be found
getStaticInstance.Object: Gets the static instance of this objects class
See all...

All man pages Function index File listing

Man pages

000.makeObjectFinalizer: Creates a standalone finalizer function for Object
abort: Aborts the current expression call
argsToString.Class: Gets the arguments of a function as a character string
argsToString.Rdoc: Gets the arguments signature of a function
as.character.BasicObject: Gets a character string representing the object
as.character.Class: Returns a short string describing the class
as.character.Exception: Gets a character string representing of the Exception
as.character.Interface: Gets a character string representing the Interface
as.character.Object: Gets a character string representing the object
as.character.Package: Gets a string representation of this package
as.character.RccViolationException: Gets a string representing of the RCC violation
as.character.RdocException: Gets a character string representing of the RdocException
ASCII: 8-bit ASCII table
attach.BasicObject: Attach an BasicObject to the R search path
attachLocally.Object: Attaches an Object locally to an environment
attach.Object: Attaches an Object to the R search path
BasicObject: A root class like Object but without references
charToInt: Converts a vector of ASCII characters into a vector of...
check.Rdoc: Checks the compiled Rd files
Class: The Class class describes an Object class
clearCache.Object: Clear fields that are defined to have cached values
clearLookupCache.Object: Clear internal fields used for faster lookup
clone.Object: Clones an Object
compileRdoc: Compiles the Rdoc help comments in a package
compile.Rdoc: Compile source code files containing Rdoc comments into Rd...
createManPath.Rdoc: Creates the directory where the Rd files should be saved
createName.Rdoc: Creates a class-method name
declaration.Rdoc: Gets the class declaration
detach.BasicObject: Detach an BasicObject from the R search path
detach.Object: Detach an Object from the R search path
dimension: Gets the dimension of the object
DOLLAR.BasicObject: Makes the fields and methods of an BasicObject accessable via...
DOLLAR.Class: Makes the fields and methods of an Class accessable via the...
DOLLARLT_-.BasicObject: Makes the fields and methods of an BasicObject assignable via...
DOLLARLT_-.Class: Makes the fields and methods of an Class assignable via the...
DOLLARLT_-.Object: Makes the fields and methods of an Object assignable via the...
DOLLAR.Object: Makes the fields and methods of an Object accessable via the...
equals: Compares an object with another
equals.BasicObject: Compares an object with another
equals.Object: Compares an object with another
escapeRdFilename.Rdoc: Escape non-valid characters in a filename
Exception: The Exception class to be thrown and caught
extend: Extends a object
extend.BasicObject: Extends another class
extend.Interface: Extends another Interface class
extend.Object: Extends another class
finalize.Object: Finalizer methods called when object is clean out
forName.Class: Gets a Class object by a name of a class
gc.Object: Deprecated: Clear cached fields and calls the garbage...
getAuthor.Package: Gets the Author of this package
getBundle.Package: Gets the Bundle that this package might belong to
getBundlePackages.Package: Gets the names of the other packages that is in the same...
getCalls.Exception: Gets the active calls saved when the exception was created
getChangeLog.Package: Gets the change log of this package
getClasses.Package: Gets all classes of a package
getClassS4Usage.Rdoc: Gets the usage of a S4 class
getConstructorS3: Get a constructor method
getContents.Package: Gets the contents of this package
getContribUrl.Package: Gets the URL(s) from where this package can be installed
getDataPath.Package: Gets the path to the data (data/) directory of this package
getDate.Package: Gets the date when package was build
getDescriptionFile.Package: Gets the description file of this package
getDescription.Package: Gets the description of the package
getDetails.Class: Lists the fields and methods of a class
getDevelUrl.Package: Gets the URL(s) from where the developers version of this...
getDocPath.Package: Gets the path to the accompanying documentation (doc/)...
getEnvironment.Object: Gets the environment of this object
getEnvironment.Package: Gets the environment of a loaded package
getExamplePath.Package: Gets the path to the example (R-ex/) directory of this...
getFieldModifiers.Object: Gets all types of field modifiers
getFields.BasicObject: Returns the field names of an BasicObject
getFields.Class: Returns the field names of a class
getFields.Interface: Returns NULL
getFields.Object: Returns the field names of an Object
getHowToCite.Package: Gets the citation of this package
getInstantiationTime.BasicObject: Gets the time when the object was instantiated
getInstantiationTime.Object: Gets the time when the object was instantiated
getInternalAddress.Object: Gets the memory location where the Object resides
getKeywords.Rdoc: Gets the keywords defined in R with descriptions
getKnownSubclasses.Class: Gets all subclasses that are currently loaded
getKnownSubclasses.classRepresentation: Gets the known subclasses
getLastException.Exception: Static method to get the last Exception thrown
getLicense.Package: Gets the License of this package
getMaintainer.Package: Gets the Maintainer of this package
getManPath.Rdoc: Gets the path to the directory where the Rd files will be...
getMessage.Exception: Gets the message of the Exception
getMessage.InternalErrorException: Gets the message of the exception
getMethods.Class: Returns the method names of class and its super classes
getName.Class: Gets the name of the class
getName.environment: Gets the name of an environment
getNameFormat.Rdoc: Gets the current name format
getName.Package: Gets the name of this package
getPackage.Class: Gets the package to which the class belongs
getPackage.InternalErrorException: Gets the suspicious package likely to contain an error
getPackageNameOf.Rdoc: Gets the package of a method or an object
getPath.Package: Gets the library (system) path to this package
getPosition.Package: Gets the search path position of the package
getRccUrl.RccViolationException: Static method to get a URL where the RCC can be found
getRdDeclaration.Class: Gets the class declaraction in Rd format
getRdDeclaration.classRepresentation: Gets the class declaration in Rd format
getRdHierarchy.Class: Gets the class hierarchy in Rd format
getRdHierarchy.classRepresentation: Gets the class hierarchy in Rd format
getRdMethods.Class: Gets the methods of a class in Rd format
getRdMethods.classRepresentation: Gets the methods in Rd format
getRdTitle.Rdoc: Extracts the title string of a Rd file
getSource.RdocException: Gets the source of the exception
getStackTrace.Exception: Gets the stack trace saved when the exception was created
getStackTraceString.Exception: Gets the stack trace as a string
getStaticInstance.Class: Gets the static instance of this class
getStaticInstance.Object: Gets the static instance of this objects class
getSuperclasses.Class: Gets the super classes of this class
getSuperclasses.classRepresentation: Gets the superclasses
getTitle.Package: Gets the Title of this package
getUrl.Package: Gets the URL of this package
getUsage.Rdoc: Gets the usage of a method
getVersion.Package: Gets the version of this package
getWhen.Exception: Gets the time when the Exception was created
hasField.BasicObject: Checks if a field exists or not
hasField.Object: Checks if a field exists or not
hashCode: Gets an integer hashcoded for R objects
hashCode.BasicObject: Gets a hash code for the object
hashCode.Object: Gets a hash code for the Object
hierarchy.Rdoc: Gets the class hierarchy
Interface: The Interface class
InternalErrorException: InternalErrorException represents internal errors
intToChar: Converts a vector of integers into a vector of ASCII...
isAbstract.Class: Checks if a class is abstract or not
isBeingCreated.Class: Checks if a class is currently being initiated initiated
isDeprecated.Class: Checks if a class is deprecated or not
isKeyword.Rdoc: Checks if a word is a Rd keyword
isLoaded.Package: Checks if the package is installed on the search path or not
isOlderThan.Package: Checks if the package is older than a given version
isPrivate.Class: Checks if a class is defined private or not
isProtected.Class: Checks if a class is defined protected or not
isPublic.Class: Checks if a class is defined public or not
isReferable.BasicObject: Checks if the object is referable or not
isReferable.Object: Checks if the object is referable or not
isStatic.Class: Checks if a class is static or not
isVisible.Rdoc: Checks if a member is visible given its modifiers
ll: Generates a list of informative properties of all members of...
ll.Object: Generates a list of informative properties of all members of...
ll.Package: Generates a list of informative properties of all members of...
load.Object: Static method to load an Object from a file or a connection
load.Package: Loads a package
methodsInheritedFrom.Rdoc: Gets all methods inherited from a class in Rd format
newInstance.BasicObject: Creates a new instance of the same class as this object
newInstance.Class: Creates a new instance of this class
newInstance.Object: Creates a new instance of the same class as this object
Non-documented_objects: Non-documented objects
novirtual.Object: Returns a reference to the same Object with virtual fields...
Object: The root class that every class must inherit from
objectSize: Gets the size of the object in bytes
objectSize.BasicObject: Gets the size of the BasicObject in bytes
objectSize.environment: Gets the size of an environment in bytes
objectSize.Object: Gets the size of the Object in bytes
Package: The Package class provides methods for accessing package...
print.BasicObject: Prints an BasicObject
print.Class: Prints detailed information about the class and its fields...
print.Exception: Prints the Exception
print.Interface: Prints an Interface
print.Object: Prints an Object
printStackTrace.Exception: Prints the stack trace saved when the exception was created
RccViolationException: An RccViolationException indicates a violation of the R...
Rdoc: Class for converting Rdoc comments to Rd files
RdocException: RdocException are thrown by the Rdoc compiler
registerFinalizer.Object: Deprecated: Registers a finalizer hook for the object...
R.oo-package: Package R.oo
save.Object: Saves an Object to a file or a connection
setConstructorS3: Defines a class in S3/UseMethod style
setManPath.Rdoc: Sets the path to the directory where the Rd files should be...
setNameFormat.Rdoc: Sets the current name format
showChangeLog.Package: Show the change log of this package
showContents.Package: Show the CONTENTS file of this package
showDescriptionFile.Package: Show the DESCRIPTION file of this package
showHowToCite.Package: Show the HOWTOCITE file of this package
startupMessage.Package: Generates a 'package successfully loaded' package startup...
staticCode.Object: Method that will be call each time a new instance of a class...
throw: Throws an Exception
throw.error: Throws (rethrows) an object of class 'error'
throw.Exception: Throws an Exception that can be caught
trim: Converts to a string and removes leading and trailing...
typeOfClass: Gets the type of a class (S3 or S4)
unload.Package: Unloads a package
update.Package: Deprecated: Updates the package is a newer version is...
uses.Interface: Specifies that an object uses this Interface

Functions

Files

inst
inst/CITATION
inst/misc
inst/misc/Exception.R
inst/misc/ASCII.R
inst/doc
inst/doc/Bengtsson.pdf
tests
tests/StaticMethodsAndNamespaces.R
tests/Object.R
tests/objectSize.R
tests/Package.R
tests/equals.R
tests/extend.default.R
tests/local.R
tests/Exception.R
tests/attachLocally.Object.R
tests/Package.unload.R
tests/hashCode.R
tests/getConstructorS3.R
tests/Object.finalize.R
tests/throw.R
tests/typeOfClass.R
tests/ASCII.R
tests/BasicObject.R
tests/trim.R
tests/Interface.R
tests/ll.R
tests/Object.finalize,noattach.R
tests/abort.R
tests/Object.finalize,onoff.R
tests/Class.R
tests/InternalErrorException.reportBug.R
tests/zzz.Object.finalize,reentrant.R
tests/isBeingCreated.Class.R
NAMESPACE
NEWS
R
R/error.throw.R
R/equals.default.R
R/000.R
R/Rdoc.R
R/Package.R
R/020.makeObjectFinalizer,private.R
R/dimension.default.R
R/extend.default.R
R/Exception.R
R/hashCode.R
R/999.DEPRECATED.R
R/getConstructorS3.R
R/060.Class.R
R/objectSize.default.R
R/typeOfClass.R
R/050.Object.R
R/RdocException.R
R/ASCII.R
R/Class.misc.R
R/030.ObjectClassFunctions.R
R/zzz.rJava-tweaks.R
R/classRepresentation.misc.R
R/getName.environment.R
R/BasicObject.R
R/InternalErrorException.R
R/ll.default.R
R/006.fixVarArgs.R
R/objectSize.environment.R
R/trim.R
R/Interface.R
R/compileRdoc.R
R/abort.R
R/999.NonDocumentedObjects.R
R/999.package.R
R/getNnnByName.R
R/zzz.R
R/throw.default.R
R/RccViolationException.R
R/040.setConstructorS3.R
MD5
DESCRIPTION
man
man/getSuperclasses.Class.Rd
man/getDocPath.Package.Rd
man/isAbstract.Class.Rd
man/DOLLARLT_-.Class.Rd
man/hashCode.Rd
man/getKeywords.Rdoc.Rd
man/DOLLAR.BasicObject.Rd
man/getUrl.Package.Rd
man/detach.BasicObject.Rd
man/extend.Interface.Rd
man/escapeRdFilename.Rdoc.Rd
man/getMaintainer.Package.Rd
man/getName.environment.Rd
man/getPosition.Package.Rd
man/argsToString.Class.Rd
man/hierarchy.Rdoc.Rd
man/getHowToCite.Package.Rd
man/createManPath.Rdoc.Rd
man/extend.BasicObject.Rd
man/getRdMethods.classRepresentation.Rd
man/throw.error.Rd
man/setNameFormat.Rdoc.Rd
man/isLoaded.Package.Rd
man/showContents.Package.Rd
man/print.Object.Rd
man/compileRdoc.Rd
man/load.Object.Rd
man/uses.Interface.Rd
man/hasField.BasicObject.Rd
man/isVisible.Rdoc.Rd
man/getMethods.Class.Rd
man/BasicObject.Rd
man/getStackTraceString.Exception.Rd
man/charToInt.Rd
man/createName.Rdoc.Rd
man/intToChar.Rd
man/getMessage.InternalErrorException.Rd
man/Exception.Rd
man/getFields.Object.Rd
man/clone.Object.Rd
man/getRdHierarchy.Class.Rd
man/DOLLARLT_-.BasicObject.Rd
man/Rdoc.Rd
man/getEnvironment.Object.Rd
man/hashCode.BasicObject.Rd
man/isPrivate.Class.Rd
man/print.Class.Rd
man/update.Package.Rd
man/getInstantiationTime.BasicObject.Rd
man/getConstructorS3.Rd
man/hasField.Object.Rd
man/equals.Object.Rd
man/staticCode.Object.Rd
man/getStaticInstance.Class.Rd
man/getNameFormat.Rdoc.Rd
man/getContents.Package.Rd
man/throw.Rd
man/newInstance.Object.Rd
man/getStaticInstance.Object.Rd
man/newInstance.Class.Rd
man/as.character.RccViolationException.Rd
man/extend.Object.Rd
man/isReferable.BasicObject.Rd
man/getPath.Package.Rd
man/print.Exception.Rd
man/ll.Rd
man/objectSize.BasicObject.Rd
man/argsToString.Rdoc.Rd
man/Object.Rd
man/isReferable.Object.Rd
man/getSource.RdocException.Rd
man/showChangeLog.Package.Rd
man/as.character.BasicObject.Rd
man/getStackTrace.Exception.Rd
man/getFieldModifiers.Object.Rd
man/showDescriptionFile.Package.Rd
man/setManPath.Rdoc.Rd
man/forName.Class.Rd
man/as.character.Object.Rd
man/abort.Rd
man/clearCache.Object.Rd
man/getClasses.Package.Rd
man/getDetails.Class.Rd
man/getDescription.Package.Rd
man/getManPath.Rdoc.Rd
man/getMessage.Exception.Rd
man/getKnownSubclasses.classRepresentation.Rd
man/objectSize.Object.Rd
man/getRdMethods.Class.Rd
man/newInstance.BasicObject.Rd
man/getPackage.Class.Rd
man/hashCode.Object.Rd
man/getWhen.Exception.Rd
man/getLicense.Package.Rd
man/novirtual.Object.Rd
man/getInstantiationTime.Object.Rd
man/detach.Object.Rd
man/getPackage.InternalErrorException.Rd
man/unload.Package.Rd
man/getDevelUrl.Package.Rd
man/DOLLAR.Class.Rd
man/Package.Rd
man/getChangeLog.Package.Rd
man/dimension.Rd
man/clearLookupCache.Object.Rd
man/objectSize.environment.Rd
man/Class.Rd
man/getSuperclasses.classRepresentation.Rd
man/getFields.BasicObject.Rd
man/getRdHierarchy.classRepresentation.Rd
man/print.Interface.Rd
man/getRdDeclaration.classRepresentation.Rd
man/registerFinalizer.Object.Rd
man/getBundle.Package.Rd
man/isOlderThan.Package.Rd
man/attach.BasicObject.Rd
man/ll.Object.Rd
man/load.Package.Rd
man/attachLocally.Object.Rd
man/000.makeObjectFinalizer.Rd
man/R.oo-package.Rd
man/save.Object.Rd
man/getDataPath.Package.Rd
man/isPublic.Class.Rd
man/as.character.RdocException.Rd
man/getCalls.Exception.Rd
man/Interface.Rd
man/getRdDeclaration.Class.Rd
man/getVersion.Package.Rd
man/startupMessage.Package.Rd
man/getRccUrl.RccViolationException.Rd
man/getFields.Class.Rd
man/ll.Package.Rd
man/RdocException.Rd
man/ASCII.Rd
man/trim.Rd
man/declaration.Rdoc.Rd
man/getClassS4Usage.Rdoc.Rd
man/typeOfClass.Rd
man/getUsage.Rdoc.Rd
man/getDescriptionFile.Package.Rd
man/equals.BasicObject.Rd
man/throw.Exception.Rd
man/as.character.Exception.Rd
man/extend.Rd
man/compile.Rdoc.Rd
man/getAuthor.Package.Rd
man/getExamplePath.Package.Rd
man/getPackageNameOf.Rdoc.Rd
man/isProtected.Class.Rd
man/setConstructorS3.Rd
man/as.character.Interface.Rd
man/finalize.Object.Rd
man/isKeyword.Rdoc.Rd
man/getEnvironment.Package.Rd
man/getDate.Package.Rd
man/DOLLARLT_-.Object.Rd
man/objectSize.Rd
man/print.BasicObject.Rd
man/as.character.Package.Rd
man/check.Rdoc.Rd
man/InternalErrorException.Rd
man/getLastException.Exception.Rd
man/attach.Object.Rd
man/isStatic.Class.Rd
man/gc.Object.Rd
man/isBeingCreated.Class.Rd
man/RccViolationException.Rd
man/getContribUrl.Package.Rd
man/getKnownSubclasses.Class.Rd
man/DOLLAR.Object.Rd
man/getTitle.Package.Rd
man/isDeprecated.Class.Rd
man/getFields.Interface.Rd
man/equals.Rd
man/getRdTitle.Rdoc.Rd
man/getName.Package.Rd
man/getBundlePackages.Package.Rd
man/getInternalAddress.Object.Rd
man/getName.Class.Rd
man/showHowToCite.Package.Rd
man/printStackTrace.Exception.Rd
man/as.character.Class.Rd
man/methodsInheritedFrom.Rdoc.Rd
man/Non-documented_objects.Rd
R.oo documentation built on May 20, 2017, 4:31 a.m.

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.