Learn R Programming

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

R.oo (version 1.22.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 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.22.0

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/HenrikBengtsson/R.oo

Maintainer

Henrik Bengtsson

Last Published

April 22nd, 2018

Functions in R.oo (1.22.0)

DOLLAR.BasicObject

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

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

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

The Package class provides methods for accessing package information

DOLLAR< -.Class

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

DOLLAR< -.Object

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

as.character.Class

Returns a short string describing the class

A root class like Object but without references

as.character.Package

Gets a string representation of this package

The Class class describes an Object class

as.character.RccViolationException

Gets a string representing of the RCC violation

as.character.Exception

Gets a character string representing of the Exception

RccViolationException

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

Clones an Object

Attaches an Object to the R search path

Compile source code files containing Rdoc comments into Rd files

Class for converting Rdoc comments to Rd files

RdocException are thrown by the Rdoc compiler

attachLocally.Object

Attaches an Object locally to an environment

Compares an object with another

Compiles the Rdoc help comments in a package

Rdoc$createManPath

Creates the directory where the Rd files should be saved

8-bit ASCII table

.makeObjectFinalizer

Creates a standalone finalizer function for Object

Compares an object with another

finalize.Object

Finalizer methods called when object is clean out

Extends a object

as.character.Interface

Gets a character string representing the Interface

Gets a Class object by a name of a class

as.character.Object

Gets a character string representing the object

The Exception class to be thrown and caught

Deprecated: Clear cached fields and calls the garbage collector

as.character.RdocException

Gets a character string representing of the RdocException

as.character.BasicObject

Gets a character string representing the object

Rdoc$argsToString

Gets the arguments signature of a function

The Interface class

Aborts the current expression call

attach.BasicObject

Attach an BasicObject to the R search path

Class$argsToString

Gets the arguments of a function as a character string

detach.BasicObject

Detach an BasicObject from the R search path

Converts a vector of ASCII characters into a vector of integers

Checks the compiled Rd files

clearCache.Object

Clear fields that are defined to have cached values

Gets the dimension of the object

getContents.Package

Gets the contents of this package

equals.BasicObject

Compares an object with another

getDataPath.Package

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

Rdoc$declaration

Gets the class declaration

Detach an Object from the R search path

Rdoc$createName

Creates a class-method name

getDate.Package

Gets the date when package was build

clearLookupCache.Object

Clear internal fields used for faster lookup

extend.Interface

Extends another Interface class

Rdoc$escapeRdFilename

Escape non-valid characters in a filename

getDocPath.Package

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

Extends another class

getEnvironment.Object

Gets the environment of this object

getAuthor.Package

Gets the Author of this package

getContribUrl.Package

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

getBundle.Package

Gets the Bundle that this package might belong to

Rdoc$getKeywords

Gets the keywords defined in R with descriptions

getInternalAddress.Object

Gets the memory location where the Object resides

getFieldModifiers.Object

Gets all types of field modifiers

Exception$getLastException

Static method to get the last Exception thrown

getFields.BasicObject

Returns the field names of an BasicObject

getLicense.Package

Gets the License of this package

getClasses.Package

Gets all classes of a package

getInstantiationTime.BasicObject

Gets the time when the object was instantiated

getName.Package

Gets the name of this package

getInstantiationTime.Object

Gets the time when the object was instantiated

getConstructorS3

Get a constructor method

getCalls.Exception

Gets the active calls saved when the exception was created

getName.environment

Gets the name of an environment

getBundlePackages.Package

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

extend.BasicObject

Extends another class

getRdDeclaration.classRepresentation

Gets the class declaration in Rd format

getDescription.Package

Gets the description of the package

RccViolationException$getRccUrl

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

getDescriptionFile.Package

Gets the description file of this package

getRdHierarchy.Class

Gets the class hierarchy in Rd format

getChangeLog.Package

Gets the change log of this package

getFields.Object

Returns the field names of an Object

getRdDeclaration.Class

Gets the class declaraction in Rd format

getRdMethods.classRepresentation

Gets the methods in Rd format

Rdoc$getRdTitle

Extracts the title string of a Rd file

getVersion.Package

Gets the version of this package

getHowToCite.Package

Gets the citation of this package

getEnvironment.Package

Gets the environment of a loaded package

getExamplePath.Package

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

getSource.RdocException

Gets the source of the exception

getMaintainer.Package

Gets the Maintainer of this package

Rdoc$getClassS4Usage

Gets the usage of a S4 class

getDetails.Class

Lists the fields and methods of a class

getDevelUrl.Package

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

getWhen.Exception

Gets the time when the Exception was created

getKnownSubclasses.Class

Gets all subclasses that are currently loaded

Gets an integer hashcoded for R objects

getFields.Class

Returns the field names of a class

getStackTrace.Exception

Gets the stack trace saved when the exception was created

Gets the class hierarchy

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

hashCode.BasicObject

Gets a hash code for the object

getKnownSubclasses.classRepresentation

Gets the known subclasses

getMethods.Class

Returns the method names of class and its super classes

hashCode.Object

Gets a hash code for the Object

getFields.Interface

getPath.Package

Gets the library (system) path to this package

Gets the name of the class

getPosition.Package

Gets the search path position of the package

getMessage.Exception

Gets the message of the Exception

Rdoc$getManPath

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

getMessage.InternalErrorException

Gets the message of the exception

isOlderThan.Package

Checks if the package is older than a given version

getStaticInstance.Object

Gets the static instance of this objects class

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

getPackage.InternalErrorException

Gets the suspicious package likely to contain an error

isPrivate.Class

Checks if a class is defined private or not

Rdoc$getPackageNameOf

Gets the package of a method or an object

getSuperclasses.Class

Gets the super classes of this class

Rdoc$getNameFormat

Gets the current name format

getStackTraceString.Exception

Gets the stack trace as a string

objectSize.BasicObject

Gets the size of the BasicObject in bytes

Gets the usage of a method

Gets the URL of this package

hasField.BasicObject

Checks if a field exists or not

getPackage.Class

Gets the package to which the class belongs

getStaticInstance.Class

Gets the static instance of this class

Checks if a word is a Rd keyword

isReferable.BasicObject

Checks if the object is referable or not

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

isLoaded.Package

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

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

Gets the size of the object in bytes

objectSize.Object

Gets the size of the Object in bytes

objectSize.environment

Gets the size of an environment in bytes

Rdoc$setManPath

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

isReferable.Object

Checks if the object is referable or not

Prints an Object

newInstance.BasicObject

Creates a new instance of the same class as this object

hasField.Object

Checks if a field exists or not

Rdoc$setNameFormat

Sets the current name format

printStackTrace.Exception

Prints the stack trace saved when the exception was created

isBeingCreated.Class

Checks if a class is currently being initiated initiated

newInstance.Class

Creates a new instance of this class

getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format

Converts to a string and removes leading and trailing whitespace

Throws (rethrows) an object of class 'error'

print.BasicObject

Prints an BasicObject

throw.Exception

Throws an Exception that can be caught

getRdMethods.Class

Gets the methods of a class in Rd format

Throws an Exception

isDeprecated.Class

Checks if a class is deprecated or not

isProtected.Class

Checks if a class is defined protected or not

Checks if a class is defined public or not

getSuperclasses.classRepresentation

Gets the superclasses

getTitle.Package

Gets the Title of this package

Converts a vector of integers into a vector of ASCII characters

Loads a package

isAbstract.Class

Checks if a class is abstract or not

Prints detailed information about the class and its fields and methods

newInstance.Object

Creates a new instance of the same class as this object

Checks if a class is static or not

Checks if a member is visible given its modifiers

novirtual.Object

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

Rdoc$methodsInheritedFrom

Gets all methods inherited from a class in Rd format

print.Exception

Prints the Exception

print.Interface

Prints an Interface

showDescriptionFile.Package

Show the DESCRIPTION file of this package

showHowToCite.Package

Show the HOWTOCITE file of this package

Saves an Object to a file or a connection

setConstructorS3

Defines a class in S3/UseMethod style

startupMessage.Package

Generates a 'package successfully loaded' package startup message

staticCode.Object

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

Gets the type of a class (S3 or S4)

Unloads a package

showChangeLog.Package

Show the change log of this package

showContents.Package

Show the CONTENTS file of this package

Specifies that an object uses this Interface

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

InternalErrorException

InternalErrorException represents internal errors

Non-documented objects

Non-documented objects