Learn R Programming

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

R.oo (version 1.7.5)

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

184,166

Version

1.7.5

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

February 3rd, 2011

Functions in R.oo (1.7.5)

getContribUrl.Package

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

Class for converting Rdoc comments to Rd files

getConstructorS3

Get a constructor method

showHowToCite.Package

Show the HOWTOCITE file of this package

attach.BasicObject

Attach an BasicObject to the R search path

Gets the usage of a method

clearCache.Object

Clear fields that are defined to have cached values

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

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

Non-documented objects

Non-documented objects

getStaticInstance.Class

Gets the static instance of this class

createName.Rdoc

Creates a class-method name

as.character.RccViolationException

Gets a string representing of the RCC violation

DOLLAR< -.BasicObject

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

Checks the compiled Rd files

argsToString.Class

Gets the arguments of a function as a character string

getPosition.Package

Gets the search path position of the package

The Class class describes an Object class

getBundlePackages.Package

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

objectSize.environment

Gets the size of an environment in bytes

as.character.BasicObject

Gets a character string representing the object

Converts a vector of ASCII characters into a vector of integers

setConstructorS3

Defines a class in S3/UseMethod style

Compares an object with another

getHowToCite.Package

Gets the howToCite of this package

Unloads a package

Attaches an Object to the R search path

getLastException.Exception

Static method to get the last Exception thrown

getAuthor.Package

Gets the Author of this package

getSource.RdocException

Gets the source of the exception

as.character.Package

Gets a string representation of this package

DOLLAR< -.Object

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

getVersion.Package

Gets the version of this package

Detach an Object from the R search path

Checks if a class is static or not

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)

getKnownSubclasses.classRepresentation

Gets the known subclasses

Gets the name of the class

getRdMethods.Class

Gets the methods of a class in Rd format

8-bit ASCII table

showChangeLog.Package

Show the change log of this package

argsToString.Rdoc

Gets the arguments signature of a function

getPath.Package

Gets the library (system) path to this package

hasField.Object

Checks if a field exists or not

as.character.Object

Gets a character string representing the object

Converts a vector of integers into a vector of ASCII characters

The Exception class to be thrown and caught

getDetails.Class

Lists the fields and methods of a class

getFields.Object

Returns the field names of an Object

Clear cached fields and calls the garbage collector

getBundle.Package

Gets the Bundle that this package might belong to

as.character.Exception

Gets a character string representing of the Exception

getMethods.Class

Returns the method names of class and its super classes

InternalErrorException

InternalErrorException represents internal errors

getManPath.Rdoc

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

The Package class provides methods for accessing package information

getDevelUrl.Package

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

getKnownSubclasses.Class

Gets all subclasses that are currently loaded

getEnvironment.Package

Gets the environment of a loaded package

setManPath.Rdoc

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

as.character.Class

Returns a short string describing the class

getWhen.Exception

Gets the time when the Exception was created

isReferable.Object

Checks if the object is referable or not

getPackage.Class

Gets the package to which the class belongs

getClassS4Usage.Rdoc

Gets the usage of a S4 class

Prints detailed information about the class and its fields and methods

print.Exception

Prints the Exception

Gets the dimension of the object

getRdDeclaration.Class

Gets the class declaraction in Rd format

getClasses.Package

Gets all classes of a package

newInstance.Object

Creates a new instance of the same class as this object

getMaintainer.Package

Gets the Maintainer of this package

getDescriptionFile.Package

Gets the description file of this package

getNameFormat.Rdoc

Gets the current name format

getFields.Class

Returns the field names of a class

getInternalAddress.Object

Gets the memory location where the Object resides

Throws an Exception

getRdHierarchy.Class

Gets the class hierarchy in Rd format

Compile source code files containing Rdoc comments into Rd files

Gets an integer hashcoded for R objects

detach.BasicObject

Detach an BasicObject from the R search path

as.character.RdocException

Gets a character string representing of the RdocException

The Interface class

Extends a object

createManPath.Rdoc

Creates the directory where the Rd files should be saved

The root class that every class must inherit from

equals.BasicObject

Compares an object with another

getRdTitle.Rdoc

Extracts the title string of a Rd file

Saves an Object to a file or a connection

Gets the type of a class (S3 or S4)

Checks if a member is visible given its modifiers

getDataPath.Package

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

getExamplePath.Package

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

isReferable.BasicObject

Checks if the object is referable or not

isOlderThan.Package

Checks if the package is older than a given version

hashCode.Object

Gets a hash code for the Object

Compares an object with another

isPrivate.Class

Checks if a class is defined private or not

Gets the size of the object in bytes

getLicense.Package

Gets the License of this package

getEnvironment.Object

Gets the environment of this object

getSuperclasses.Class

Gets the super classes of this class

getName.environment

Gets the name of an environment

getStackTrace.Exception

Gets the stack trace saved when the exception was created

extend.Interface

Extends another Interface class

getStaticInstance.Object

Gets the static instance of this objects class

getFields.BasicObject

Returns the field names of an BasicObject

getDocPath.Package

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

Throws (rethrows) an object of class 'error'

getRccUrl.RccViolationException

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

Gets a Class object by a name of a class

getPackage.InternalErrorException

Gets the suspicious package likely to contain an error

Gets the URL of this package

getFields.Interface

Extends another class

Converts to a string and removes leading and trailing whitespace

getMessage.InternalErrorException

Gets the message of the exception

registerFinalizer.Object

Registers a finalizer hook for the object

DOLLAR< -.Class

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

hasField.BasicObject

Checks if a field exists or not

Gets the class hierarchy

getInstantiationTime.BasicObject

Gets the time when the object was instantiated

isBeingCreated.Class

Checks if a class is currently being initiated initiated

Checks if a class is defined public or not

getSuperclasses.classRepresentation

Gets the superclasses

as.character.Interface

Gets a character string representing the Interface

RdocException are thrown by the Rdoc compiler

newInstance.Class

Creates a new instance of this class

hashCode.BasicObject

Gets a hash code for the object

Loads a package

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

getName.Package

Gets the name of this package

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

getStackTraceString.Exception

Gets the stack trace as a string

extend.BasicObject

Extends another class

getTitle.Package

Gets the Title of this package

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

Checks if a word is a Rd keyword

print.Interface

Prints an Interface

Prints an Object

print.BasicObject

Prints an BasicObject

printStackTrace.Exception

Prints the stack trace saved when the exception was created

getDate.Package

Gets the date when package was build

getMessage.Exception

Gets the message of the Exception

getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format

staticCode.Object

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

setNameFormat.Rdoc

Sets the current name format

getRdMethods.classRepresentation

Gets the methods in Rd format

objectSize.BasicObject

Gets the size of the BasicObject in bytes

isProtected.Class

Checks if a class is defined protected or not

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

novirtual.Object

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

getDescription.Package

Gets the description of the package

isAbstract.Class

Checks if a class is abstract or not

objectSize.Object

Gets the size of the Object in bytes

throw.Exception

Throws an Exception that can be caught

Updates the package is a newer version is available

Specifies that an object uses this Interface

showContents.Package

Show the CONTENTS file of this package

showDescriptionFile.Package

Show the DESCRIPTION file of this package

DOLLAR.BasicObject

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

attachLocally.Object

Attaches an Object locally to an environment

declaration.Rdoc

Gets the class declaration

escapeRdFilename.Rdoc

Escape non-valid characters in a filename

getInstantiationTime.Object

Gets the time when the object was instantiated

getPackageNameOf.Rdoc

Gets the package of a method or an object

getRdDeclaration.classRepresentation

Gets the class declaration in Rd format

isDeprecated.Class

Checks if a class is deprecated or not

methodsInheritedFrom.Rdoc

Gets all methods inherited from a class in Rd format

getChangeLog.Package

Gets the change log of this package

A root class like Object but without references

finalize.Object

Finalizer methods called when object is clean out

getKeywords.Rdoc

Gets the keywords defined in R with descriptions

Clones an Object

getContents.Package

Gets the contents of this package