Learn R Programming

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

R.oo (version 1.4.2)

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

Copy Link

Version

Install

install.packages('R.oo')

Monthly Downloads

240,913

Version

1.4.2

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

January 24th, 2024

Functions in R.oo (1.4.2)

DOLLAR.BasicObject

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

Extends another class

getRccUrl.RccViolationException

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

getStaticInstance.Class

Gets the static instance of this class

attach.BasicObject

Attach an BasicObject to the Rsearch path

as.character.Class

Returns a short string describing the class

declaration.Rdoc

Gets the class declaration

Gets the dimension of the object

getDataPath.Package

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

newInstance.Object

Creates a new instance of the same class as this object

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

getHowToCite.Package

Gets the howToCite of this package

getLastException.Exception

Static method to get the last Exception thrown

print.BasicObject

Prints an BasicObject

as.character.Package

Gets a string representation of this package

Compares an object with another

detach.BasicObject

Detach an BasicObject from the Rsearch path

getInstanciationTime.Object

Gets the time when the object was instanciated

getDate.Package

Gets the date when package was build

getFields.Class

Returns the field names of a class

Gets the URL of this package

getDetails.Class

Lists the fields and methods of a class

Throws (rethrows) an object of class 'error'

newInstance.Class

Creates a new instance of this class

hashCode.BasicObject

Gets a hash code for the object

getSource.RdocException

Gets the source of the exception

Converts to a string and removes leading and trailing whitespace

The Package class provides methods for accessing package information

Non-documented objects

Non-documented objects

isProtected.Class

Checks if a class is defined protected or not

isBeingCreated.Class

Checks if a class is currently being initiated initiated

getDescriptionFile.Package

Gets the description file of this package

Compile source code files containing Rdoc comments into Rd files

getNameFormat.Rdoc

Gets the current name format

getRdTitle.Rdoc

Extracts the title string of a Rd file

getKnownSubclasses.classRepresentation

Gets the known subclasses

getName.Package

Gets the name of this package

Clones an Object

Unloads a package

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

Checks if a class is defined public or not

InternalErrorException

InternalErrorException represents internal errors

Checks the compiled Rd files

showChangeLog.Package

Show the change log of this package

attachLocally.Object

Attaches an Object locally to an environment

getBundle.Package

Gets the Bundle that this package might belong to

hasField.BasicObject

Checks if a field exists or not

setConstructorS3

Defines a class in S3/UseMethod style

A root class like Object but without references

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

RdocException are thrown by the Rdoc compiler

Checks if a class is static or not

getRdHierarchy.Class

Gets the class hierarchy in Rd format

createManPath.Rdoc

Creates the directory where the Rd files should be saved

Prints detailed information about the class and its fields and methods

createName.Rdoc

Creates a class-method name

hasField.Object

Checks if a field exists or not

escapeRdFilename.Rdoc

Escape non-valid characters in a filename

getInstanciationTime.BasicObject

Gets the time when the object was instanciated

Attaches an Object to the Rsearch path

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

isLoaded.Package

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

showDescriptionFile.Package

Show the DESCRIPTION file of this package

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

getSuperclasses.classRepresentation

Gets the superclasses

extend.BasicObject

Extends another class

finalize.Object

Finalizer methods called when object is clean out

argsToString.Class

Gets the arguments of a function as a character string

getExamplePath.Package

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

getClasses.Package

Gets all classes of a package

getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format

getStaticInstance.Object

Gets the static instance of this objects class

hashCode.Object

Gets a hash code for the Object

getEnvironment.Package

Gets the environment of a loaded package

getContents.Package

Gets the contents of this package

getInternalAddress.Object

Gets the memory location where the Object resides

isReferable.Object

Checks if the object is referable or not

as.character.Exception

Gets a character string representing of the Exception

The Exception class to be thrown and caught

getPackage.Class

Gets the package to which the class belongs

getMethods.Class

Returns the method names of class and its super classes

getKnownSubclasses.Class

Gets all subclasses that are currently loaded

Gets an integer hashcoded for Robjects

Saves an Object to a file or a connection

Converts a vector of ASCII characters into a vector of integers

getMessage.Exception

Gets the message of the Exception

RccViolationException

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

isReferable.BasicObject

Checks if the object is referable or not

getPackageNameOf.Rdoc

Gets the package of a method or an object

isAbstract.Class

Checks if a class is abstract or not

getStackTraceString.Exception

Gets the stack trace as a string

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

The Class class describes an Object class

Gets the size of the object in bytes

as.character.RccViolationException

Gets a string representing of the RCC violation

objectSize.Object

Gets the size of the Object in bytes

Detach an Object from the Rsearch path

DOLLAR< -.Object

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

getPosition.Package

Gets the search path position of the package

getAuthor.Package

Gets the Author of this package

Class for converting Rdoc comments to Rd files

getSuperclasses.Class

Gets the super classes of this class

Gets the usage of a method

getChangeLog.Package

Gets the change log of this package

getTitle.Package

Gets the Title of this package

Throws an Exception

getMessage.InternalErrorException

Gets the message of the exception

getRdMethods.Class

Gets the methods of a class in Rd format

getStackTrace.Exception

Gets the stack trace saved when the exception was created

Checks if a word is a Rd keyword

getBundlePackages.Package

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

setNameFormat.Rdoc

Sets the current name format

Gets the class hierarchy

getRdMethods.classRepresentation

Gets the methods in Rd format

getRdDeclaration.Class

Gets the class declaraction in Rd format

showHowToCite.Package

Show the HOWTOCITE file of this package

setManPath.Rdoc

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

showContents.Package

Show the CONTENTS file of this package

as.character.BasicObject

Gets a character string representing the object

Checks if a member is visible given its modifiers

equals.BasicObject

Compares an object with another

Clear cached fields and calls the garbage collector

clearCache.Object

Clear fields that are defined to have cached values

DOLLAR< -.Class

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

objectSize.BasicObject

Gets the size of the BasicObject in bytes

Converts a vector of integers into a vector of ASCII characters

getManPath.Rdoc

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

printStackTrace.Exception

Prints the stack trace saved when the exception was created

getDescription.Package

Gets the description of the package

getKeywords.Rdoc

Gets the keywords defined in R with descriptions

getWhen.Exception

Gets the time when the Exception was created

Loads a package

methodsInheritedFrom.Rdoc

Gets all methods inherited from a class in Rd format

Gets the type of a class (S3 or S4)

getVersion.Package

Gets the version of this package

getClassS4Usage.Rdoc

Gets the usage of a S4 class

getFields.Object

Returns the field names of an Object

Prints an Object

as.character.RdocException

Gets a character string representing of the RdocException

getContribUrl.Package

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

Gets the name of the class

Compares an object with another

getFields.BasicObject

Returns the field names of an BasicObject

getMaintainer.Package

Gets the Maintainer of this package

isPrivate.Class

Checks if a class is defined private or not

getLicense.Package

Gets the License of this package

print.Exception

Prints the Exception

novirtual.Object

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

DOLLAR< -.BasicObject

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

The root class that every class must inherit from

getDevelUrl.Package

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

Extends a object

getRdDeclaration.classRepresentation

Gets the class declaration in Rd format

isDeprecated.Class

Checks if a class is deprecated or not

8-bit ASCII table

as.character.Object

Gets a character string representing the object

Gets a Class object by a name of a class

argsToString.Rdoc

Gets the arguments signature of a function

getDocPath.Package

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

getEnvironment.Object

Gets the environment of this object

getPath.Package

Gets the library (system) path to this package

throw.Exception

Throws an Exception that can be caught

staticCode.Object

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

getPackage.InternalErrorException

Gets the suspicious package likely to contain an error

Updates the package is a newer version is available