Learn R Programming

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

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Last Published

January 24th, 2024

Functions in R.oo (1.26.0)

.makeObjectFinalizer

Creates a standalone finalizer function for Object
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
ASCII

8-bit ASCII table
Rdoc

Class for converting Rdoc comments to Rd files
InternalErrorException

InternalErrorException represents internal errors
Non-documented objects

Non-documented objects
as.character.Package

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

Gets a string representing of the RCC violation
Exception

The Exception class to be thrown and caught
clone.Object

Clones an Object
Interface

The Interface class
Rdoc$escapeRdFilename

Escape non-valid characters in a filename
RdocException

RdocException are thrown by the Rdoc compiler
Rdoc$compile

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

Compares an object with another
equals

Compares an object with another
Rdoc$argsToString

Gets the arguments signature of a function
Class$forName

Gets a Class object by a name of a class
getAuthor.Package

Gets the Author of this package
extend.BasicObject

Extends another class
getConstructorS3

Get a constructor method
as.character.BasicObject

Gets a character string representing the object
getContents.Package

Gets the contents of this package
getCalls.Exception

Gets the active calls saved when the exception was created
DOLLAR.Object

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

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

Attaches an Object to the R search path
getChangeLog.Package

Gets the change log of this package
getFields.BasicObject

Returns the field names of an BasicObject
getInstantiationTime.Object

Gets the time when the object was instantiated
attachLocally.Object

Attaches an Object locally to an environment
getInternalAddress.Object

Gets the memory location where the Object resides
getFields.Class

Returns the field names of a class
getMessage.InternalErrorException

Gets the message of the exception
R.oo-package

Package R.oo
getFields.Interface

Returns NULL
dimension

Gets the dimension of the object
equals.BasicObject

Compares an object with another
Rdoc$getClassS4Usage

Gets the usage of a S4 class
getMethods.Class

Returns the method names of class and its super classes
getFields.Object

Returns the field names of an Object
getClasses.Package

Gets all classes of a package
getEnvironment.Object

Gets the environment of this object
hasField.Object

Checks if a field exists or not
getEnvironment.Package

Gets the environment of a loaded package
getName.Class

Gets the name of the class
getName.Package

Gets the name of this package
RccViolationException

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

A root class like Object but without references
getRdHierarchy.Class

Gets the class hierarchy in Rd format
Rdoc$getKeywords

Gets the keywords defined in R with descriptions
abort

Aborts the current expression call
Class

The Class class describes an Object class
hashCode.BasicObject

Gets a hash code for the object
getRdHierarchy.classRepresentation

Gets the class hierarchy in Rd format
Class$argsToString

Gets the arguments of a function as a character string
DOLLAR.BasicObject

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

The root class that every class must inherit from
getKnownSubclasses.Class

Gets all subclasses that are currently loaded
Rdoc$getManPath

Gets the path to the directory where the Rd files will be saved
getSuperclasses.Class

Gets the super classes of this class
Package

The Package class provides methods for accessing package information
charToInt

Converts a vector of ASCII characters into a vector of integers
isAbstract.Class

Checks if a class is abstract or not
getSuperclasses.classRepresentation

Gets the superclasses
isBeingCreated.Class

Checks if a class is currently being initiated initiated
as.character.Class

Returns a short string describing the class
novirtual.Object

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

Gets the size of the BasicObject in bytes
getWhen.Exception

Gets the time when the Exception was created
printStackTrace.Exception

Prints the stack trace saved when the exception was created
check.Rdoc

Checks the compiled Rd files
hasField.BasicObject

Checks if a field exists or not
Rdoc$hierarchy

Gets the class hierarchy
save.Object

Saves an Object to a file or a connection
getMessage.Exception

Gets the message of the Exception
compileRdoc

Compiles the Rdoc help comments in a package
as.character.Exception

Gets a character string representing of the Exception
getPosition.Package

Gets the search path position of the package
DOLLAR.Class

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

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

Creates the directory where the Rd files should be saved
as.character.RdocException

Gets a character string representing of the RdocException
intToChar

Converts a vector of integers into a vector of ASCII characters
as.character.Interface

Gets a character string representing the Interface
getRdMethods.Class

Gets the methods of a class in Rd format
getRdMethods.classRepresentation

Gets the methods in Rd format
extend

Extends a object
attach.BasicObject

Attach an BasicObject to the R search path
hashCode.Object

Gets a hash code for the Object
finalize.Object

Finalizer methods called when object is clean out
Object$load

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

Gets the date when package was build
hashCode

Gets an integer hashcoded for R objects
detach.BasicObject

Detach an BasicObject from the R search path
as.character.Object

Gets a character string representing the object
isPrivate.Class

Checks if a class is defined private or not
detach.Object

Detach an Object from the R search path
getDescription.Package

Gets the description of the package
load.Package

Loads a package
objectSize.Object

Gets the size of the Object in bytes
clearCache.Object

Clear fields that are defined to have cached values
clearLookupCache.Object

Clear internal fields used for faster lookup
isProtected.Class

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

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

Gets the size of the object in bytes
Rdoc$createName

Creates a class-method name
print.Class

Prints detailed information about the class and its fields and methods
extend.Interface

Extends another Interface class
print.Exception

Prints the Exception
getDescriptionFile.Package

Gets the description file of this package
ll

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

Gets the size of an environment in bytes
Rdoc$declaration

Gets the class declaration
print.BasicObject

Prints an BasicObject
getBundle.Package

Gets the Bundle that this package might belong to
getDetails.Class

Lists the fields and methods of a class
getBundlePackages.Package

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

Gets the package of a method or an object
extend.Object

Extends another class
getPath.Package

Gets the library (system) path to this package
getContribUrl.Package

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

Show the CONTENTS file of this package
getExamplePath.Package

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

Show the DESCRIPTION file of this package
getFieldModifiers.Object

Gets all types of field modifiers
print.Interface

Prints an Interface
getDataPath.Package

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

Prints an Object
throw

Throws an Exception
getKnownSubclasses.classRepresentation

Gets the known subclasses
Exception$getLastException

Static method to get the last Exception thrown
getDevelUrl.Package

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

Throws (rethrows) an object of class 'error'
getDocPath.Package

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

Gets the citation of this package
getStackTrace.Exception

Gets the stack trace saved when the exception was created
getName.environment

Gets the name of an environment
getStackTraceString.Exception

Gets the stack trace as a string
Rdoc$getUsage

Gets the usage of a method
getInstantiationTime.BasicObject

Gets the time when the object was instantiated
getLicense.Package

Gets the License of this package
getMaintainer.Package

Gets the Maintainer of this package
getPackage.Class

Gets the package to which the class belongs
getVersion.Package

Gets the version of this package
isDeprecated.Class

Checks if a class is deprecated or not
getPackage.InternalErrorException

Gets the suspicious package likely to contain an error
Rdoc$getRdTitle

Extracts the title string of a Rd file
Rdoc$getNameFormat

Gets the current name format
Rdoc$isKeyword

Checks if a word is a Rd keyword
isPublic.Class

Checks if a class is defined public or not
isReferable.BasicObject

Checks if the object is referable or not
newInstance.Class

Creates a new instance of this class
getSource.RdocException

Gets the source of the exception
isReferable.Object

Checks if the object is referable or not
newInstance.Object

Creates a new instance of the same class as this object
Rdoc$setNameFormat

Sets the current name format
isStatic.Class

Checks if a class is static or not
getRdDeclaration.Class

Gets the class declaration in Rd format
setConstructorS3

Defines a class in S3/UseMethod style
getRdDeclaration.classRepresentation

Gets the class declaration in Rd format
Rdoc$setManPath

Sets the path to the directory where the Rd files should be saved
showChangeLog.Package

Show the change log of this package
trim

Converts to a string and removes leading and trailing whitespace
typeOfClass

Gets the type of a class (S3 or S4)
unload.Package

Unloads a package
staticCode.Object

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

Throws an Exception that can be caught
uses.Interface

Specifies that an object uses this Interface
getStaticInstance.Class

Gets the static instance of this class
getStaticInstance.Object

Gets the static instance of this objects class
getTitle.Package

Gets the Title of this package
getUrl.Package

Gets the URL of this package
isLoaded.Package

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

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

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

Generates a list of informative properties of all members of an Object
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
showHowToCite.Package

Show the HOWTOCITE file of this package
startupMessage.Package

Generates a 'package successfully loaded' package startup message