Learn R Programming

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

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

165,817

Version

1.23.0

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Repository

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

Maintainer

Henrik Bengtsson

Last Published

November 3rd, 2019

Functions in R.oo (1.23.0)

Aborts the current expression call

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

RccViolationException

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

Class$argsToString

Gets the arguments of a function as a character string

clearCache.Object

Clear fields that are defined to have cached values

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

The Class class describes an Object class

Non-documented objects

Non-documented objects

as.character.Class

Returns a short string describing the class

InternalErrorException

InternalErrorException represents internal errors

as.character.Exception

Gets a character string representing of the Exception

The root class that every class must inherit from

DOLLAR< -.BasicObject

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

extend.Interface

Extends another Interface class

Rdoc$declaration

Gets the class declaration

clearLookupCache.Object

Clear internal fields used for faster lookup

Rdoc$createName

Creates a class-method name

Extends another class

as.character.Object

Gets a character string representing the object

as.character.Interface

Gets a character string representing the Interface

The Package class provides methods for accessing package information

Compares an object with another

Compares an object with another

attachLocally.Object

Attaches an Object locally to an environment

Attaches an Object to the R search path

Extends a object

extend.BasicObject

Extends another class

getContribUrl.Package

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

Rdoc$escapeRdFilename

Escape non-valid characters in a filename

Rdoc$getClassS4Usage

Gets the usage of a S4 class

getClasses.Package

Gets all classes of a package

getDevelUrl.Package

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

finalize.Object

Finalizer methods called when object is clean out

8-bit ASCII table

.makeObjectFinalizer

Creates a standalone finalizer function for Object

Rdoc$argsToString

Gets the arguments signature of a function

getPackage.InternalErrorException

Gets the suspicious package likely to contain an error

getPackage.Class

Gets the package to which the class belongs

Rdoc$getRdTitle

Extracts the title string of a Rd file

getKnownSubclasses.classRepresentation

Gets the known subclasses

Exception$getLastException

Static method to get the last Exception thrown

getDocPath.Package

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

getDataPath.Package

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

as.character.BasicObject

Gets a character string representing the object

DOLLAR< -.Class

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

getEnvironment.Object

Gets the environment of this object

DOLLAR< -.Object

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

getContents.Package

Gets the contents of this package

getFieldModifiers.Object

Gets all types of field modifiers

getConstructorS3

Get a constructor method

getExamplePath.Package

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

getFields.Interface

getFields.Object

Returns the field names of an Object

getMethods.Class

Returns the method names of class and its super classes

getMessage.InternalErrorException

Gets the message of the exception

Class for converting Rdoc comments to Rd files

getRdHierarchy.Class

Gets the class hierarchy in Rd format

Rdoc$getNameFormat

Gets the current name format

getEnvironment.Package

Gets the environment of a loaded package

getName.environment

Gets the name of an environment

Gets the usage of a method

getSource.RdocException

Gets the source of the exception

getVersion.Package

Gets the version of this package

The Exception class to be thrown and caught

RdocException are thrown by the Rdoc compiler

getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format

Clones an Object

getBundle.Package

Gets the Bundle that this package might belong to

detach.BasicObject

Detach an BasicObject from the R search path

as.character.Package

Gets a string representation of this package

The Interface class

as.character.RdocException

Gets a character string representing of the RdocException

getPosition.Package

Gets the search path position of the package

Detach an Object from the R search path

attach.BasicObject

Attach an BasicObject to the R search path

getBundlePackages.Package

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

as.character.RccViolationException

Gets a string representing of the RCC violation

RccViolationException$getRccUrl

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

Converts a vector of ASCII characters into a vector of integers

Compiles the Rdoc help comments in a package

Rdoc$createManPath

Creates the directory where the Rd files should be saved

getAuthor.Package

Gets the Author of this package

getCalls.Exception

Gets the active calls saved when the exception was created

getStaticInstance.Class

Gets the static instance of this class

Gets a Class object by a name of a class

getChangeLog.Package

Gets the change log of this package

Checks the compiled Rd files

getDate.Package

Gets the date when package was build

getStackTrace.Exception

Gets the stack trace saved when the exception was created

getRdDeclaration.Class

Gets the class declaration in Rd format

getStaticInstance.Object

Gets the static instance of this objects class

Gets the dimension of the object

Compile source code files containing Rdoc comments into Rd files

getLicense.Package

Gets the License of this package

equals.BasicObject

Compares an object with another

getInstantiationTime.Object

Gets the time when the object was instantiated

getRdDeclaration.classRepresentation

Gets the class declaration in Rd format

getMaintainer.Package

Gets the Maintainer of this package

getInternalAddress.Object

Gets the memory location where the Object resides

isReferable.Object

Checks if the object is referable or not

getRdMethods.classRepresentation

Gets the methods in Rd format

getRdMethods.Class

Gets the methods of a class in Rd format

getStackTraceString.Exception

Gets the stack trace as a string

isOlderThan.Package

Checks if the package is older than a given version

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

isLoaded.Package

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

getDetails.Class

Lists the fields and methods of a class

getInstantiationTime.BasicObject

Gets the time when the object was instantiated

getHowToCite.Package

Gets the citation of this package

getDescriptionFile.Package

Gets the description file of this package

Rdoc$getManPath

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

hashCode.Object

Gets a hash code for the Object

getTitle.Package

Gets the Title of this package

getMessage.Exception

Gets the message of the Exception

getFields.BasicObject

Returns the field names of an BasicObject

getDescription.Package

Gets the description of the package

getFields.Class

Returns the field names of a class

Rdoc$getKeywords

Gets the keywords defined in R with descriptions

Gets the name of the class

Checks if a class is static or not

getKnownSubclasses.Class

Gets all subclasses that are currently loaded

Gets an integer hashcoded for R objects

Rdoc$methodsInheritedFrom

Gets all methods inherited from a class in Rd format

Gets the URL of this package

Converts a vector of integers into a vector of ASCII characters

Gets the class hierarchy

Loads a package

Checks if a member is visible given its modifiers

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

isAbstract.Class

Checks if a class is abstract or not

getWhen.Exception

Gets the time when the Exception was created

hasField.BasicObject

Checks if a field exists or not

isBeingCreated.Class

Checks if a class is currently being initiated initiated

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

getPath.Package

Gets the library (system) path to this package

Rdoc$getPackageNameOf

Gets the package of a method or an object

getName.Package

Gets the name of this package

setConstructorS3

Defines a class in S3/UseMethod style

newInstance.BasicObject

Creates a new instance of the same class as this object

printStackTrace.Exception

Prints the stack trace saved when the exception was created

Rdoc$setManPath

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

newInstance.Class

Creates a new instance of this class

Gets the type of a class (S3 or S4)

Converts to a string and removes leading and trailing whitespace

isPrivate.Class

Checks if a class is defined private or not

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

newInstance.Object

Creates a new instance of the same class as this object

objectSize.environment

Gets the size of an environment in bytes

Checks if a word is a Rd keyword

hashCode.BasicObject

Gets a hash code for the object

isReferable.BasicObject

Checks if the object is referable or not

getSuperclasses.classRepresentation

Gets the superclasses

getSuperclasses.Class

Gets the super classes of this class

objectSize.Object

Gets the size of the Object in bytes

hasField.Object

Checks if a field exists or not

Checks if a class is defined public or not

isDeprecated.Class

Checks if a class is deprecated or not

print.BasicObject

Prints an BasicObject

isProtected.Class

Checks if a class is defined protected or not

Prints an Object

print.Interface

Prints an Interface

showHowToCite.Package

Show the HOWTOCITE file of this package

Saves an Object to a file or a connection

startupMessage.Package

Generates a 'package successfully loaded' package startup message

throw.Exception

Throws an Exception that can be caught

Gets the size of the object in bytes

staticCode.Object

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

Rdoc$setNameFormat

Sets the current name format

novirtual.Object

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

Unloads a package

showChangeLog.Package

Show the change log of this package

objectSize.BasicObject

Gets the size of the BasicObject in bytes

print.Exception

Prints the Exception

Throws an Exception

Throws (rethrows) an object of class 'error'

Prints detailed information about the class and its fields and methods

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

A root class like Object but without references

DOLLAR.BasicObject

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