Learn R Programming

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

R.oo (version 1.2.3)

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

172,478

Version

1.2.3

License

LGPL version 2.1 or newer (the releases)

Maintainer

Henrik Bengtsson

Last Published

January 24th, 2024

Functions in R.oo (1.2.3)

getDataPath.Package

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

getContribUrl.Package

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

The Class class describes an Object class

getNameFormat.Rdoc

Gets the current name format

8-bit ASCII table

getPackageNameOf.Rdoc

Gets the package of a method or an object

getStackTrace.Exception

Gets the stack trace saved when the exception was created

DOLLAR< -.Class

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

Gets the dimension of the object

Gets an integer hashcoded for Robjects

getDocPath.Package

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

Loads a package

Extends a object

as.character.Exception

Gets a character string representing of the Exception

getDescriptionFile.Package

Gets the description file of this package

as.character.RdocException

Gets a character string representing of the RdocException

isDeprecated.Class

Checks if a class is deprecated or not

Attaches an Object to the Rsearch path

as.character.BasicObject

Gets a character string representing the object

The root class that every class must inherit from

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

Send a bug report about the last Exception thrown

getAuthor.Package

Gets the Author of this package

getSuperclasses.Class

Gets the super classes of this class

The Exception class to be thrown and caught

Gets the usage of a method

getVersion.Package

Gets the version of this package

escapeRdFilename.Rdoc

Escape non-valid characters in a filename

Gets the class hierarchy

Converts a vector of ASCII characters into a vector of integers

as.character.Object

Gets a character string representing the object

getMaintainer.Package

Gets the Maintainer of this package

Compile source code files containing Rdoc comments into Rd files

clearCache.Object

Clear fields that are defined to have cached values

as.character.Class

Returns a short string describing the class

getDescription.Package

Gets the description of the package

isReferable.Object

Checks if the object is referable or not

extend.BasicObject

Extends another class

Detach an Object from the Rsearch path

getRdDeclaration.Class

Gets the class declaraction in Rd format

isLoaded.Package

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

RccViolationException

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

reportBug.InternalErrorException

Send a bug report

The Package class provides methods for accessing package information

getSuperclasses.classRepresentation

Gets the superclasses

getInstanciationTime.Object

Gets the time when the object was instanciated

getBundlePackages.Package

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

getKnownSubclasses.Class

Gets all subclasses that are currently loaded

objectSize.Object

Gets the size of the Object in bytes

getRdHierarchy.Class

Gets the class hierarchy in Rd format

getSource.RdocException

Gets the source of the exception

DOLLAR< -.Object

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

getTitle.Package

Gets the Title of this package

DOLLAR.BasicObject

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

setManPath.Rdoc

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

methodsInheritedFrom.Rdoc

Gets all methods inherited from a class in Rd format

setConstructorS3

Defines a class in S3/UseMethod style

as.character.RccViolationException

Gets a string representing of the RCC violation

createManPath.Rdoc

Creates the directory where the Rd files should be saved

getPackage.InternalErrorException

Gets the suspicious package likely to contain an error

getKnownSubclasses.classRepresentation

Gets the known subclasses

Gets a Class object by a name of a class

printStackTrace.Exception

Prints the stack trace saved when the exception was created

getLicense.Package

Gets the License of this package

getExamplePath.Package

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

argsToString.Class

Gets the arguments of a function as a character string

argsToString.Rdoc

Gets the arguments signature of a function

Gets the type of a class (S3 or S4)

getPosition.Package

Gets the search path position of the package

hasField.BasicObject

Checks if a field exists or not

Saves an Object to a file or a connection

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

showDescriptionFile.Package

Show the DESCRIPTION file of this package

Compares an object with another

Checks if a member is visible given its modifiers

showHowToCite.Package

Show the HOWTOCITE file of this package

print.BasicObject

Prints an BasicObject

newInstance.Class

Creates a new instance of this class

Creates a method for a class using S3/UseMethod style

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

Prints detailed information about the class and its fields and methods

Reserved words in R not to be used for object names

getClassS4Usage.Rdoc

Gets the usage of a S4 class

Throws (rethrows) an object of class 'error'

getRccUrl.RccViolationException

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

getEnvironment.Object

Gets the environment of this object

detach.BasicObject

Detach an BasicObject from the Rsearch path

getRdMethods.Class

Gets the methods of a class in Rd format

DOLLAR< -.BasicObject

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

Gets the name of the class

Compares an object with another

Converts to a string and removes leading and trailing whitespace

showAndWait.simpleError

Display the message to the user and wait for the user to respond

Checks the compiled Rd files

Clear cached fields and calls the garbage collector

getMethods.Class

Returns the method names of class and its super classes

Evaluates an expression with the possibility to catch exceptions (DEPRECATED)

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

equals.BasicObject

Compares an object with another

Clones an Object

hashCode.BasicObject

Gets a hash code for the object

createName.Rdoc

Creates a class-method name

isAbstract.Class

Checks if a class is abstract or not

getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format

Checks if a word is a Rd keyword

getFields.Class

Returns the field names of a class

getPath.Package

Gets the library (system) path to this package

print.Exception

Prints the Exception

getRdMethods.classRepresentation

Gets the methods in Rd format

getStackTraceString.Exception

Gets the stack trace as a string

attach.BasicObject

Attach an BasicObject to the Rsearch path

getChangeLog.Package

Gets the change log of this package

getRdTitle.Rdoc

Extracts the title string of a Rd file

Checks if a function is a S3/UseMethod generic function

showChangeLog.Package

Show the change log of this package

hashCode.Object

Gets a hash code for the Object

isBeingCreated.Class

Checks if a class is currently being initiated initiated

objectSize.BasicObject

Gets the size of the BasicObject in bytes

declaration.Rdoc

Gets the class declaration

Extends another class

getBundle.Package

Gets the Bundle that this package might belong to

Unloads a package

Creates a generic function in S3/UseMethod style

A root class like Object but without references

as.character.Package

Gets a string representation of this package

getDetails.Class

Lists the fields and methods of a class

getHowToCite.Package

Gets the howToCite of this package

getClasses.Package

Gets all classes of a package

getContents.Package

Gets the contents of this package

getMessage.Exception

Gets the message of the Exception

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

getMessage.InternalErrorException

Gets the message of the exception

getInternalAddress.Object

Gets the memory location where the Object resides

getManPath.Rdoc

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

Converts a vector of integers into a vector of ASCII characters

Gets the URL of this package

getKeywords.Rdoc

Gets the keywords defined in R with descriptions

getWhen.Exception

Gets the time when the Exception was created

Checks if a class is defined public or not

getLastException.Exception

Static method to get the last Exception thrown

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

isPrivate.Class

Checks if a class is defined private or not

Checks if a function is a S4 generic function

getRdDeclaration.classRepresentation

Gets the class declaration in Rd format

RdocException are thrown by the Rdoc compiler

getPackage.Class

Gets the package to which the class belongs

showContents.Package

Show the CONTENTS file of this package

Class for converting Rdoc comments to Rd files

staticCode.Object

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

Prints an Object

novirtual.Object

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

Updates the package is a newer version is available

getName.Package

Gets the name of this package

getDate.Package

Gets the date when package was build

isProtected.Class

Checks if a class is defined protected or not

newInstance.Object

Creates a new instance of the same class as this object

setNameFormat.Rdoc

Sets the current name format

isReferable.BasicObject

Checks if the object is referable or not

attachLocally.Object

Attaches an Object locally to an environment

finalize.Object

Finalizer methods called when object is clean out

hasField.Object

Checks if a field exists or not

Checks if a class is static or not

throw.Exception

Throws an Exception that can be caught

Throws an Exception

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

InternalErrorException

InternalErrorException represents internal errors

Non-documented objects

Non-documented objects

getFields.BasicObject

Returns the field names of an BasicObject

getEnvironment.Package

Gets the environment of a loaded package

getStaticInstance.Class

Gets the static instance of this class

getFields.Object

Returns the field names of an Object

getStaticInstance.Object

Gets the static instance of this objects class