R.oo v1.0.3

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 maintainance for package developers. For example, generic functions are created automatically, if missing, and name conflict are automatically solved, if possible. The method setMethodS3() is a good start for those who in the future want to migrate to S4. The package has been developed since 2001 and is now considered very stable.

Functions in R.oo

Name Description
DOLLAR.Class Makes the fields and methods of an Class accessable via the $ and the [[ operator
getDescriptionFile.Package Gets the description file of this package
detach.Object Detach an Object from the Rsearch path
equals.Object Compares an object with another
getLicense.Package Gets the License of this package
charToInt Converts a vector of integers into a vector of ASCII characters
RccViolationException An RccViolationException indicates a violation of the R Coding Conventions (RCC)
check.Rdoc Checks the compiled Rd files
getBundlePackages.Package Gets the names of the other packages that is in the same bundle as this package
getAuthor.Package Gets the Author of this package
Package The Package class provides methods for accessing package information
getClasses.Package Gets all classes of a package
getPackage.InternalErrorException Gets the suspicious package likely to contain an error
createManPath.Rdoc Creates the directory where the Rd files should be saved
getFields.BasicObject Returns the field names of an BasicObject
as.character.Object Gets a character string representing the object
getInternalAddress.Object Gets the memory location where the Object resides
load.Package Loads a package
getEnvironment.Package Gets the environment of a loaded package
InternalErrorException InternalErrorException represents internal errors
BasicObject A root class like Object but without references
getRdHierarchy.classRepresentation Gets the class hierarchy in Rd format
getInstanciationTime.BasicObject Gets the time when the object was instanciated
as.character.Package Gets a string representation of this package
as.character.Exception Gets a character string representing of the Exception
getLastException.Exception Static method to get the last Exception thrown
Object The root class that every class must inherit from
as.character.BasicObject Gets a character string representing the object
getHistory.Package Gets the history of this package
getDate.Package Gets the date when package was build
getRdHierarchy.Class Gets the class hierarchy in Rd format
DOLLAR.BasicObject Makes the fields and methods of an BasicObject accessable via the $ and the [[ operator
Exception The Exception class to be thrown and caught
. About this package About this package
as.character.RdocException Gets a character string representing of the RdocException
getDevelUrl.Package Gets the URL(s) from where the developers version of this package can be installed
DOLLAR< -.Class Makes the fields and methods of an Class assignable via the $
getStackTrace.Exception Gets the stack trace saved when the exception was created
getUrl.Package Gets the URL of this package
getPath.Package Gets the library (system) path to this package
getPackage.Class Gets the package to which the class belongs
escapeRdFilename.Rdoc Escape non-valid characters in a filename
clone.Object Clones an Object
getBundle.Package Gets the Bundle that this package might belong to
getMessage.Exception Gets the message of the Exception
getHowToCite.Package Gets the howToCite of this package
getSuperclasses.classRepresentation Gets the superclasses
forName.Class Gets a Class object by a name of a class
attach.BasicObject Attach an BasicObject to the Rsearch path
getStaticInstance.Object Gets the static instance of this objects class
getKeywords.Rdoc Gets the keywords defined in R with descriptions
getFields.Class Returns the field names of a class
getName.Package Gets the name of this package
detach.BasicObject Detach an BasicObject from the Rsearch path
finalize.Object Finalizer methods called when object is clean out
methodsInheritedFrom.Rdoc Gets all methods inherited from a class in Rd format
isLoaded.Package Checks if the package is installed on the search path or not
getName.Class Gets the name of the class
hasField.Object Checks if a field exists or not
getDetails.Class Lists the fields and methods of a class
argsToString.Class Gets the arguments of a function as a character string
createName.Rdoc Creates a class-method name
Class The Class class describes an Object class
attach.Object Attach an Object to the Rsearch path
isPrivate.Class Checks if a class is defined private or not
isReferable.BasicObject Checks if the object is referable or not
DOLLAR< -.Object Makes the fields and methods of an Object assignable via the $
isKeyword.Rdoc Checks if a word is a Rd keyword
R.KEYWORDS Reserved words in R not to be used for object names
getRdDeclaration.Class Gets the class declaraction in Rd format
Non-documented objects Non-documented objects
intToChar Converts a vector of ASCII characters into a vector of integers
as.character.Class Returns a short string describing the class
extend.Object Extends another class
dimension Gets the dimension of the object
getRdTitle.Rdoc Extracts the title string of a Rd file
getMethods.Class Returns the method names of class and its super classes
getPosition.Package Gets the search path position of the package
argsToString.Rdoc Gets the arguments signature of a function
getDocPath.Package Gets the path to the accompanying documentation (doc/) directory of this package
compile.Rdoc Compile source code files containing Rdoc comments into Rd files
isStatic.Class Checks if a class is static or not
declaration.Rdoc Gets the class declaration
RdocException RdocException are thrown by the Rdoc compiler
hasField.BasicObject Checks if a field exists or not
getExamplePath.Package Gets the path to the example (R-ex/) directory of this package
getSuperclasses.Class Gets the super classes of this class
getRdMethods.Class Gets the methods of a class in Rd format
getKnownSubclasses.Class Gets all subclasses that are currently loaded
isReferable.Object Checks if the object is referable or not
getStaticInstance.Class Gets the static instance of this class
ll.Object Generates a list of informative properties of all members of an Object
equals Compares an object with another
getUsage.Rdoc Gets the usage of a method
isAbstract.Class Checks if a class is abstract or not
getWhen.Exception Gets the time when the Exception was created
getClassS4Usage.Rdoc Gets the usage of a S4 class
getDescription.Package Gets the description of the package
getInstanciationTime.Object Gets the time when the object was instanciated
isProtected.Class Checks if a class is defined protected or not
load.Object Static method to load an Object from a file or a connection
ll.Package Generates a list of informative properties of all members of the package
getFields.Object Returns the field names of an Object
isGenericS4 Checks if a function is a S4 generic function
getManPath.Rdoc Gets the path to the directory where the Rd files will be saved
getNameFormat.Rdoc Gets the current name format
getKnownSubclasses.classRepresentation Gets the known subclasses
ASCII 8-bit ASCII table
Rdoc Class for converting Rdoc comments to Rd files
getPackageNameOf.Rdoc Gets the package of a method or an object
isPublic.Class Checks if a class is defined public or not
DOLLAR.Object Makes the fields and methods of an Object accessable via the $ and the [[ operator
getRccUrl.RccViolationException Static method to get a URL where the RCC can be found
ll Generates a list of informative properties of all members of an environment
DOLLAR< -.BasicObject Makes the fields and methods of an BasicObject assignable via the $
getMessage.InternalErrorException Gets the message of the exception
equals.BasicObject Compares an object with another
update.Package Updates the package is a newer version is available
setConstructorS3 Defines a class in S3/UseMethod style
print.Class Prints detailed information about the class and its fields and methods
print.Object Prints an Object
objectSize.Object Gets the size of the Object in bytes
setMethodS3 Creates a method for a class using S3/UseMethod style
save.Object Saves an Object to a file or a connection
throw.error Throws (rethrows) an object of class 'error'
showAndWait.simpleError Display the message to the user and wait for the user to respond
trim Converts to a string and removes leading and trailing whitespace
showContents.Package Show the CONTENTS file of this package
reportBug.InternalErrorException Send a bug report
trycatch Evaluates an expression with the possibility to catch exceptions (DEPRECATED)
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
showDescriptionFile.Package Show the DESCRIPTION file of this package
hashCode.Object Gets a hash code for the Object
throw.Exception Throws an Exception that can be caught
typeOfClass Gets the type of a class (S3 or S4)
printStackTrace.Exception Prints the stack trace saved when the exception was created
setManPath.Rdoc Sets the path to the directory where the Rd files should be saved
getMaintainer.Package Gets the Maintainer of this package
print.Exception Prints the Exception
getStackTraceString.Exception Gets the stack trace as a string
getRdMethods.classRepresentation Gets the methods in Rd format
getContribUrl.Package Gets the URL(s) from where this package can be installed
getContents.Package Gets the contents of this package
getTitle.Package Gets the Title of this package
objectSize.BasicObject Gets the size of the BasicObject in bytes
reportBug Send a bug report about the last Exception thrown
isGenericS3 Checks if a function is a S3/UseMethod generic function
getSource.RdocException Gets the source of the exception
novirtual.Object Returns a reference to the same Object with virtual fields turned off
hashCode Gets an integer hashcoded for Robjects
throw Throws an Exception
getRdDeclaration.classRepresentation Gets the class declaration in Rd format
newInstance.Class Creates a new instance of this class
getDataPath.Package Gets the path to the data (data/) directory of this package
unload.Package Unloads a package
showHowToCite.Package Show the HOWTOCITE file of this package
showHistory.Package Show the HISTORY file of this package
setGenericS3 Creates a generic function in S3/UseMethod style
setNameFormat.Rdoc Sets the current name format
print.BasicObject Prints an BasicObject
as.character.RccViolationException Gets a string representing of the RCC violation
hashCode.BasicObject Gets a hash code for the object
hierarchy.Rdoc Gets the class hierarchy
extend.BasicObject Extends another class
isDeprecated.Class Checks if a class is deprecated or not
No Results!

Last month downloads

Details

Date 2005-05-02
License GPL version 2 or newer
URL http://www.braju.com/R/
DevelURL http://www.maths.lth.se/help/R/
LazyLoad TRUE
Packaged Tue May 3 13:38:18 2005; hb
Contributors Henrik Bengtsson

Include our badge in your README

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