Learn R Programming

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

R.oo (version 1.2.7)

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

187,540

Version

1.2.7

License

LGPL version 2.1 or newer (the releases)

Maintainer

Henrik Bengtsson

Last Published

January 24th, 2024

Functions in R.oo (1.2.7)

Checks the compiled Rd files

Gets the name of the class

getRdMethods.Class

Gets the methods of a class in Rd format

Gets the class hierarchy

getBundle.Package

Gets the Bundle that this package might belong to

Checks if a function is a S4 generic function

getPackage.Class

Gets the package to which the class belongs

getRdDeclaration.classRepresentation

Gets the class declaration in Rd format

getSuperclasses.Class

Gets the super classes of this class

getMessage.InternalErrorException

Gets the message of the exception

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

getLicense.Package

Gets the License of this package

Gets the size of the object in bytes

getKnownSubclasses.classRepresentation

Gets the known subclasses

DOLLAR.BasicObject

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

RdocException are thrown by the Rdoc compiler

DOLLAR< -.Object

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

showAndWait.simpleError

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

as.character.RccViolationException

Gets a string representing of the RCC violation

novirtual.Object

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

throw.Exception

Throws an Exception that can be caught

Detach an Object from the Rsearch path

8-bit ASCII table

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

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

InternalErrorException

InternalErrorException represents internal errors

The Exception class to be thrown and caught

getContribUrl.Package

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

Clear cached fields and calls the garbage collector

A root class like Object but without references

getMaintainer.Package

Gets the Maintainer of this package

getSource.RdocException

Gets the source of the exception

Compares an object with another

hasField.BasicObject

Checks if a field exists or not

The root class that every class must inherit from

getKnownSubclasses.Class

Gets all subclasses that are currently loaded

getPackageNameOf.Rdoc

Gets the package of a method or an object

getPackage.InternalErrorException

Gets the suspicious package likely to contain an error

isLoaded.Package

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

Reserved words in R not to be used for object names

setConstructorS3

Defines a class in S3/UseMethod style

extend.BasicObject

Extends another class

getStaticInstance.Class

Gets the static instance of this class

Attaches an Object to the Rsearch path

as.character.Class

Returns a short string describing the class

hashCode.BasicObject

Gets a hash code for the object

Saves an Object to a file or a connection

getTitle.Package

Gets the Title of this package

Converts a vector of ASCII characters into a vector of integers

hashCode.Object

Gets a hash code for the Object

argsToString.Class

Gets the arguments of a function as a character string

getDevelUrl.Package

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

Extends another class

showChangeLog.Package

Show the change log of this package

getEnvironment.Object

Gets the environment of this object

getExamplePath.Package

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

Gets the dimension of the object

getClasses.Package

Gets all classes of a package

getClassS4Usage.Rdoc

Gets the usage of a S4 class

getFields.Class

Returns the field names of a class

Gets the URL of this package

getFields.BasicObject

Returns the field names of an BasicObject

getRdDeclaration.Class

Gets the class declaraction in Rd format

print.BasicObject

Prints an BasicObject

getRdMethods.classRepresentation

Gets the methods in Rd format

getMethods.Class

Returns the method names of class and its super classes

isPrivate.Class

Checks if a class is defined private or not

getStaticInstance.Object

Gets the static instance of this objects class

objectSize.BasicObject

Gets the size of the BasicObject in bytes

equals.BasicObject

Compares an object with another

showContents.Package

Show the CONTENTS file of this package

Prints an Object

isProtected.Class

Checks if a class is defined protected or not

as.character.RdocException

Gets a character string representing of the RdocException

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

Converts a vector of integers into a vector of ASCII characters

Checks if a member is visible given its modifiers

Checks if a class is defined public or not

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

printStackTrace.Exception

Prints the stack trace saved when the exception was created

declaration.Rdoc

Gets the class declaration

getDataPath.Package

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

showHowToCite.Package

Show the HOWTOCITE file of this package

Non-documented objects

Non-documented objects

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

getHowToCite.Package

Gets the howToCite of this package

getDocPath.Package

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

Clones an Object

methodsInheritedFrom.Rdoc

Gets all methods inherited from a class in Rd format

clearCache.Object

Clear fields that are defined to have cached values

Creates a generic function in S3/UseMethod style

staticCode.Object

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

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

Prints detailed information about the class and its fields and methods

The Package class provides methods for accessing package information

getWhen.Exception

Gets the time when the Exception was created

finalize.Object

Finalizer methods called when object is clean out

getInternalAddress.Object

Gets the memory location where the Object resides

getPath.Package

Gets the library (system) path to this package

Gets an integer hashcoded for Robjects

getManPath.Rdoc

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

isReferable.Object

Checks if the object is referable or not

as.character.BasicObject

Gets a character string representing the object

objectSize.Object

Gets the size of the Object in bytes

attachLocally.Object

Attaches an Object locally to an environment

Gets the type of a class (S3 or S4)

newInstance.Object

Creates a new instance of the same class as this object

Compares an object with another

getStackTraceString.Exception

Gets the stack trace as a string

isDeprecated.Class

Checks if a class is deprecated or not

getNameFormat.Rdoc

Gets the current name format

getFields.Object

Returns the field names of an Object

getDate.Package

Gets the date when package was build

escapeRdFilename.Rdoc

Escape non-valid characters in a filename

isBeingCreated.Class

Checks if a class is currently being initiated initiated

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

getBundlePackages.Package

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

Loads a package

DOLLAR< -.Class

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

argsToString.Rdoc

Gets the arguments signature of a function

getVersion.Package

Gets the version of this package

attach.BasicObject

Attach an BasicObject to the Rsearch path

The Class class describes an Object class

getRccUrl.RccViolationException

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

getInstanciationTime.BasicObject

Gets the time when the object was instanciated

getDescriptionFile.Package

Gets the description file of this package

createManPath.Rdoc

Creates the directory where the Rd files should be saved

Converts to a string and removes leading and trailing whitespace

getLastException.Exception

Static method to get the last Exception thrown

getAuthor.Package

Gets the Author of this package

getRdTitle.Rdoc

Extracts the title string of a Rd file

Unloads a package

print.Exception

Prints the Exception

Checks if a function is a S3/UseMethod generic function

setNameFormat.Rdoc

Sets the current name format

Gets a Class object by a name of a class

Throws (rethrows) an object of class 'error'

getDetails.Class

Lists the fields and methods of a class

getInstanciationTime.Object

Gets the time when the object was instanciated

isAbstract.Class

Checks if a class is abstract or not

getSuperclasses.classRepresentation

Gets the superclasses

Class for converting Rdoc comments to Rd files

Updates the package is a newer version is available

Checks if a class is static or not

newInstance.Class

Creates a new instance of this class

showDescriptionFile.Package

Show the DESCRIPTION file of this package

hasField.Object

Checks if a field exists or not

as.character.Exception

Gets a character string representing of the Exception

RccViolationException

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

detach.BasicObject

Detach an BasicObject from the Rsearch path

getMessage.Exception

Gets the message of the Exception

getName.Package

Gets the name of this package

Gets the usage of a method

getRdHierarchy.Class

Gets the class hierarchy in Rd format

Checks if a word is a Rd keyword

isReferable.BasicObject

Checks if the object is referable or not

Compile source code files containing Rdoc comments into Rd files

getStackTrace.Exception

Gets the stack trace saved when the exception was created

DOLLAR< -.BasicObject

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

createName.Rdoc

Creates a class-method name

as.character.Package

Gets a string representation of this package

as.character.Object

Gets a character string representing the object

Extends a object

getChangeLog.Package

Gets the change log of this package

getDescription.Package

Gets the description of the package

getContents.Package

Gets the contents of this package

getPosition.Package

Gets the search path position of the package

getEnvironment.Package

Gets the environment of a loaded package

Creates a method for a class using S3/UseMethod style

getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format

Throws an Exception