R.oo v1.20.0

0

Monthly downloads

0th

Percentile

R Object-Oriented Programming with or without References

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.

Functions in R.oo

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

Last month downloads

Details

Date 2016-02-17
License LGPL (>= 2.1)
LazyLoad TRUE
URL https://github.com/HenrikBengtsson/R.oo
BugReports https://github.com/HenrikBengtsson/R.oo/issues
NeedsCompilation no
Packaged 2016-02-17 20:15:51 UTC; hb
Repository CRAN
Date/Publication 2016-02-17 22:31:34

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/R.oo)](http://www.rdocumentation.org/packages/R.oo)