Learn R Programming

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

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

187,540

Version

1.21.0

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Last Published

November 1st, 2016

Functions in R.oo (1.21.0)

Class$argsToString

Gets the arguments of a function as a character string
as.character.Package

Gets a string representation of this package
as.character.Object

Gets a character string representing the object
as.character.Exception

Gets a character string representing of the Exception
as.character.Interface

Gets a character string representing the Interface
abort

Aborts the current expression call
as.character.Class

Returns a short string describing the class
.makeObjectFinalizer

Creates a standalone finalizer function for Object
Rdoc$argsToString

Gets the arguments signature of a function
as.character.BasicObject

Gets a character string representing the object
as.character.RccViolationException

Gets a string representing of the RCC violation
BasicObject

A root class like Object but without references
attach.Object

Attaches an Object to the R search path
as.character.RdocException

Gets a character string representing of the RdocException
charToInt

Converts a vector of ASCII characters into a vector of integers
attachLocally.Object

Attaches an Object locally to an environment
ASCII

8-bit ASCII table
check.Rdoc

Checks the compiled Rd files
attach.BasicObject

Attach an BasicObject to the R search path
Class

The Class class describes an Object class
Rdoc$createManPath

Creates the directory where the Rd files should be saved
clone.Object

Clones an Object
Rdoc$createName

Creates a class-method name
Rdoc$declaration

Gets the class declaration
detach.Object

Detach an Object from the R search path
clearLookupCache.Object

Clear internal fields used for faster lookup
compileRdoc

Compiles the Rdoc help comments in a package
Rdoc$compile

Compile source code files containing Rdoc comments into Rd files
clearCache.Object

Clear fields that are defined to have cached values
detach.BasicObject

Detach an BasicObject from the R search path
DOLLAR.Object

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

Makes the fields and methods of an BasicObject accessable via the \$ and the [[ operator
DOLLAR< -.BasicObject

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

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

Compares an object with another
equals.Object

Compares an object with another
dimension

Gets the dimension of the object
DOLLAR.Class

Makes the fields and methods of an Class accessable via the \$ and the [[ operator
DOLLAR< -.Object

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

Compares an object with another
extend.BasicObject

Extends another class
Class$forName

Gets a Class object by a name of a class
extend.Interface

Extends another Interface class
finalize.Object

Finalizer methods called when object is clean out
extend

Extends a object
extend.Object

Extends another class
gc.Object

Deprecated: Clear cached fields and calls the garbage collector
getAuthor.Package

Gets the Author of this package
Exception

The Exception class to be thrown and caught
Rdoc$escapeRdFilename

Escape non-valid characters in a filename
getClasses.Package

Gets all classes of a package
getDocPath.Package

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

Gets the usage of a S4 class
getDevelUrl.Package

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

Returns NULL
getFields.Object

Returns the field names of an Object
getLicense.Package

Gets the License of this package
getMaintainer.Package

Gets the Maintainer of this package
Rdoc$getNameFormat

Gets the current name format
getName.Package

Gets the name of this package
getRdMethods.Class

Gets the methods of a class in Rd format
hashCode.BasicObject

Gets a hash code for the object
getRdMethods.classRepresentation

Gets the methods in Rd format
hasField.Object

Checks if a field exists or not
intToChar

Converts a vector of integers into a vector of ASCII characters
InternalErrorException

InternalErrorException represents internal errors
isPrivate.Class

Checks if a class is defined private or not
isProtected.Class

Checks if a class is defined protected or not
load.Package

Loads a package
Object$load

Static method to load an Object from a file or a connection
getBundle.Package

Gets the Bundle that this package might belong to
getDescription.Package

Gets the description of the package
getBundlePackages.Package

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

Gets the date when package was build
Rdoc$getKeywords

Gets the keywords defined in R with descriptions
getKnownSubclasses.Class

Gets all subclasses that are currently loaded
setConstructorS3

Defines a class in S3/UseMethod style
Rdoc$setManPath

Sets the path to the directory where the Rd files should be saved
throw.Exception

Throws an Exception that can be caught
throw

Throws an Exception
typeOfClass

Gets the type of a class (S3 or S4)
trim

Converts to a string and removes leading and trailing whitespace
getMethods.Class

Returns the method names of class and its super classes
getMessage.InternalErrorException

Gets the message of the exception
getPackage.InternalErrorException

Gets the suspicious package likely to contain an error
getPackage.Class

Gets the package to which the class belongs
getRdHierarchy.Class

Gets the class hierarchy in Rd format
getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format
hashCode

Gets an integer hashcoded for R objects
hashCode.Object

Gets a hash code for the Object
getEnvironment.Object

Gets the environment of this object
getInstantiationTime.BasicObject

Gets the time when the object was instantiated
getEnvironment.Package

Gets the environment of a loaded package
Rdoc$getManPath

Gets the path to the directory where the Rd files will be saved
getHowToCite.Package

Gets the citation of this package
getMessage.Exception

Gets the message of the Exception
getConstructorS3

Get a constructor method
getContents.Package

Gets the contents of this package
getExamplePath.Package

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

Gets all types of field modifiers
getInstantiationTime.Object

Gets the time when the object was instantiated
getKnownSubclasses.classRepresentation

Gets the known subclasses
getInternalAddress.Object

Gets the memory location where the Object resides
getChangeLog.Package

Gets the change log of this package
getDescriptionFile.Package

Gets the description file of this package
getCalls.Exception

Gets the active calls saved when the exception was created
getDetails.Class

Lists the fields and methods of a class
getTitle.Package

Gets the Title of this package
getUrl.Package

Gets the URL of this package
Rdoc$hierarchy

Gets the class hierarchy
ll

Generates a list of informative properties of all members of an environment
Rdoc$isVisible

Checks if a member is visible given its modifiers
newInstance.Object

Creates a new instance of the same class as this object
newInstance.Class

Creates a new instance of this class
objectSize

Gets the size of the object in bytes
objectSize.environment

Gets the size of an environment in bytes
R.oo-package

Package R.oo
RccViolationException

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

Static method to get the last Exception thrown
getRdDeclaration.Class

Gets the class declaraction in Rd format
getRdDeclaration.classRepresentation

Gets the class declaration in Rd format
getStaticInstance.Class

Gets the static instance of this class
getSuperclasses.classRepresentation

Gets the superclasses
getSuperclasses.Class

Gets the super classes of this class
getStaticInstance.Object

Gets the static instance of this objects class
isDeprecated.Class

Checks if a class is deprecated or not
Rdoc$isKeyword

Checks if a word is a Rd keyword
isLoaded.Package

Checks if the package is installed on the search path or not
getPosition.Package

Gets the search path position of the package
RccViolationException$getRccUrl

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

Gets the stack trace saved when the exception was created
Rdoc$getUsage

Gets the usage of a method
isReferable.Object

Checks if the object is referable or not
getVersion.Package

Gets the version of this package
getStackTraceString.Exception

Gets the stack trace as a string
ll.Object

Generates a list of informative properties of all members of an Object
isStatic.Class

Checks if a class is static or not
ll.Package

Generates a list of informative properties of all members of the package
isOlderThan.Package

Checks if the package is older than a given version
Rdoc$methodsInheritedFrom

Gets all methods inherited from a class in Rd format
newInstance.BasicObject

Creates a new instance of the same class as this object
Package

The Package class provides methods for accessing package information
objectSize.Object

Gets the size of the Object in bytes
save.Object

Saves an Object to a file or a connection
Rdoc$setNameFormat

Sets the current name format
registerFinalizer.Object

Deprecated: Registers a finalizer hook for the object [DEFUNCT]
showChangeLog.Package

Show the change log of this package
showContents.Package

Show the CONTENTS file of this package
showDescriptionFile.Package

Show the DESCRIPTION file of this package
print.BasicObject

Prints an BasicObject
print.Class

Prints detailed information about the class and its fields and methods
RdocException

RdocException are thrown by the Rdoc compiler
Rdoc

Class for converting Rdoc comments to Rd files
update.Package

Deprecated: Updates the package is a newer version is available
getContribUrl.Package

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

Unloads a package
getDataPath.Package

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

Returns the field names of an BasicObject
getFields.Class

Returns the field names of a class
getName.Class

Gets the name of the class
getName.environment

Gets the name of an environment
getPath.Package

Gets the library (system) path to this package
Rdoc$getPackageNameOf

Gets the package of a method or an object
getSource.RdocException

Gets the source of the exception
getWhen.Exception

Gets the time when the Exception was created
Rdoc$getRdTitle

Extracts the title string of a Rd file
hasField.BasicObject

Checks if a field exists or not
isAbstract.Class

Checks if a class is abstract or not
isBeingCreated.Class

Checks if a class is currently being initiated initiated
print.Exception

Prints the Exception
printStackTrace.Exception

Prints the stack trace saved when the exception was created
print.Interface

Prints an Interface
showHowToCite.Package

Show the HOWTOCITE file of this package
print.Object

Prints an Object
Interface

The Interface class
isPublic.Class

Checks if a class is defined public or not
startupMessage.Package

Generates a 'package successfully loaded' package startup message
isReferable.BasicObject

Checks if the object is referable or not
Non-documented objects

Non-documented objects
novirtual.Object

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

Gets the size of the BasicObject in bytes
Object

The root class that every class must inherit from
uses.Interface

Specifies that an object uses this Interface
staticCode.Object

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

Throws (rethrows) an object of class 'error'
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
DOLLAR< -.BasicObject

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