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

Last month downloads

Details

License LGPL (>= 2.1)
LazyLoad TRUE
URL https://github.com/HenrikBengtsson/R.oo
BugReports https://github.com/HenrikBengtsson/R.oo/issues
NeedsCompilation no
Packaged 2020-08-24 16:24:06 UTC; hb
Repository CRAN
Date/Publication 2020-08-26 16:11:58 UTC

Include our badge in your README

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