Learn R Programming

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

R.oo (version 1.3.0)

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 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.

Copy Link

Version

Install

install.packages('R.oo')

Monthly Downloads

184,166

Version

1.3.0

License

LGPL version 2.1 or newer (the releases)

Maintainer

Henrik Bengtsson

Last Published

January 24th, 2024

Functions in R.oo (1.3.0)

The Package class provides methods for accessing package information

attach.BasicObject

Attach an BasicObject to the Rsearch path

clearCache.Object

Clear fields that are defined to have cached values

createName.Rdoc

Creates a class-method name

declaration.Rdoc

Gets the class declaration

getStackTraceString.Exception

Gets the stack trace as a string

getContents.Package

Gets the contents of this package

getHowToCite.Package

Gets the howToCite of this package

getChangeLog.Package

Gets the change log of this package

getDataPath.Package

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

getRccUrl.RccViolationException

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

getInstanciationTime.Object

Gets the time when the object was instanciated

staticCode.Object

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

The Class class describes an Object class

getRdDeclaration.Class

Gets the class declaraction in Rd format

detach.BasicObject

Detach an BasicObject from the Rsearch path

DOLLAR< -.Class

Makes the fields and methods of an Class assignable via the $<- and the [[<- operator

isReferable.Object

Checks if the object is referable or not

Compile source code files containing Rdoc comments into Rd files

Gets the type of a class (S3 or S4)

as.character.BasicObject

Gets a character string representing the object

8-bit ASCII table

Extends another class

newInstance.Class

Creates a new instance of this class

Checks if a function is a S3/UseMethod generic function

RccViolationException

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

Extends a object

methodsInheritedFrom.Rdoc

Gets all methods inherited from a class in Rd format

Checks if a word is a Rd keyword

Non-documented objects

Non-documented objects

isAbstract.Class

Checks if a class is abstract or not

getFields.Class

Returns the field names of a class

setNameFormat.Rdoc

Sets the current name format

DOLLAR< -.Object

Makes the fields and methods of an Object assignable via the $<- and the [[<- operator

getMaintainer.Package

Gets the Maintainer of this package

getPosition.Package

Gets the search path position of the package

The Exception class to be thrown and caught

getStaticInstance.Class

Gets the static instance of this class

Static method to load an Object from a file or a connection

argsToString.Class

Gets the arguments of a function as a character string

getPath.Package

Gets the library (system) path to this package

escapeRdFilename.Rdoc

Escape non-valid characters in a filename

Converts a vector of integers into a vector of ASCII characters

argsToString.Rdoc

Gets the arguments signature of a function

A root class like Object but without references

Checks the compiled Rd files

isProtected.Class

Checks if a class is defined protected or not

extend.BasicObject

Extends another class

as.character.Exception

Gets a character string representing of the Exception

Attaches an Object to the Rsearch path

setManPath.Rdoc

Sets the path to the directory where the Rd files should be saved

getKeywords.Rdoc

Gets the keywords defined in R with descriptions

getPackage.InternalErrorException

Gets the suspicious package likely to contain an error

Converts a vector of ASCII characters into a vector of integers

hashCode.Object

Gets a hash code for the Object

getBundlePackages.Package

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

isLoaded.Package

Checks if the package is installed on the search path or not

finalize.Object

Finalizer methods called when object is clean out

Prints detailed information about the class and its fields and methods

Gets the name of the class

Checks if a class is static or not

Compares an object with another

getName.Package

Gets the name of this package

Gets a Class object by a name of a class

getManPath.Rdoc

Gets the path to the directory where the Rd files will be saved

getKnownSubclasses.Class

Gets all subclasses that are currently loaded

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

getClassS4Usage.Rdoc

Gets the usage of a S4 class

Compares an object with another

getAuthor.Package

Gets the Author of this package

DOLLAR.BasicObject

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

getEnvironment.Package

Gets the environment of a loaded package

equals.BasicObject

Compares an object with another

as.character.Package

Gets a string representation of this package

attachLocally.Object

Attaches an Object locally to an environment

getLastException.Exception

Static method to get the last Exception thrown

getDevelUrl.Package

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

getInstanciationTime.BasicObject

Gets the time when the object was instanciated

Gets the class hierarchy

Clear cached fields and calls the garbage collector

getLicense.Package

Gets the License of this package

isPrivate.Class

Checks if a class is defined private or not

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

getRdTitle.Rdoc

Extracts the title string of a Rd file

getRdDeclaration.classRepresentation

Gets the class declaration in Rd format

Saves an Object to a file or a connection

getSource.RdocException

Gets the source of the exception

Creates a generic function in S3/UseMethod style

showHowToCite.Package

Show the HOWTOCITE file of this package

throw.Exception

Throws an Exception that can be caught

getNameFormat.Rdoc

Gets the current name format

getBundle.Package

Gets the Bundle that this package might belong to

isBeingCreated.Class

Checks if a class is currently being initiated initiated

Updates the package is a newer version is available

getDescription.Package

Gets the description of the package

getDocPath.Package

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

getEnvironment.Object

Gets the environment of this object

getMethods.Class

Returns the method names of class and its super classes

Generates a list of informative properties of all members of the package

print.BasicObject

Prints an BasicObject

The root class that every class must inherit from

as.character.Object

Gets a character string representing the object

objectSize.BasicObject

Gets the size of the BasicObject in bytes

Creates a method for a class using S3/UseMethod style

getClasses.Package

Gets all classes of a package

getDate.Package

Gets the date when package was build

Gets an integer hashcoded for Robjects

getRdMethods.classRepresentation

Gets the methods in Rd format

getFields.BasicObject

Returns the field names of an BasicObject

getSuperclasses.Class

Gets the super classes of this class

printStackTrace.Exception

Prints the stack trace saved when the exception was created

Loads a package

Gets the size of the object in bytes

getInternalAddress.Object

Gets the memory location where the Object resides

getKnownSubclasses.classRepresentation

Gets the known subclasses

getFields.Object

Returns the field names of an Object

objectSize.Object

Gets the size of the Object in bytes

print.Exception

Prints the Exception

showChangeLog.Package

Show the change log of this package

getExamplePath.Package

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

isDeprecated.Class

Checks if a class is deprecated or not

getSuperclasses.classRepresentation

Gets the superclasses

Class for converting Rdoc comments to Rd files

hashCode.BasicObject

Gets a hash code for the object

getPackageNameOf.Rdoc

Gets the package of a method or an object

getMessage.Exception

Gets the message of the Exception

getDetails.Class

Lists the fields and methods of a class

getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format

getRdMethods.Class

Gets the methods of a class in Rd format

as.character.RccViolationException

Gets a string representing of the RCC violation

Detach an Object from the Rsearch path

Checks if a class is defined public or not

getStackTrace.Exception

Gets the stack trace saved when the exception was created

getWhen.Exception

Gets the time when the Exception was created

Prints an Object

getContribUrl.Package

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

getTitle.Package

Gets the Title of this package

Generates a list of informative properties of all members of an environment

Checks if a member is visible given its modifiers

Throws an Exception

Checks if a function is a S4 generic function

Converts to a string and removes leading and trailing whitespace

Unloads a package

showContents.Package

Show the CONTENTS file of this package

getRdHierarchy.Class

Gets the class hierarchy in Rd format

hasField.Object

Checks if a field exists or not

Gets the usage of a method

RdocException are thrown by the Rdoc compiler

DOLLAR< -.BasicObject

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

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

novirtual.Object

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

as.character.Class

Returns a short string describing the class

Clones an Object

Gets the dimension of the object

createManPath.Rdoc

Creates the directory where the Rd files should be saved

getPackage.Class

Gets the package to which the class belongs

getVersion.Package

Gets the version of this package

isReferable.BasicObject

Checks if the object is referable or not

showDescriptionFile.Package

Show the DESCRIPTION file of this package

getStaticInstance.Object

Gets the static instance of this objects class

Throws (rethrows) an object of class 'error'

setConstructorS3

Defines a class in S3/UseMethod style

as.character.RdocException

Gets a character string representing of the RdocException

Reserved words in R not to be used for object names

getDescriptionFile.Package

Gets the description file of this package

getMessage.InternalErrorException

Gets the message of the exception

Gets the URL of this package

newInstance.Object

Creates a new instance of the same class as this object

hasField.BasicObject

Checks if a field exists or not

InternalErrorException

InternalErrorException represents internal errors