Package R.oo

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.

Please note that the Rdoc syntax/grammar used to convert Rdoc comments in code into Rd files is not strictly defined and is modified by the need of the author. Ideally, there will be a well defined Rdoc language one day.

Installation and updates

To install this package do

install.packages("R.oo")

Dependencies and other requirements

This package requires a standard R installation and the R.methodsS3 package.

To get started

To get started,It is very useful to understand that:

1. The setMethodS3() function, which is defined in the R.methodsS3 package (used to be part of R.oo), is nothing but a conveniency wrapper for setting up S3 methods, and automatically create an S3 generic function, if missing. For more information, see the help of R.methodsS3.

2. The Object class is a top-level "root" class that provides support for reference variables. Any class inheriting from this class supports reference variables.

3. The Object class is basically a wrapper around an environment, which some additional accessors etc. It is the environment data type that provides the "emulation" of reference variables - the Object class structure makes it easier to extends this class and adds some level of coding protection. The Object class features is not intended for referencing individual elements of basic R data types, but rather for the whole variable of such. For instance, you can reassign a whole matrix X part of the object this way, but you cannot reassign X[1,1] without creating a completely new copy.

Further readings

For a detailed introduction to the package see [1] (part of the package distribution).

How to cite this package

Whenever using this package, please cite [1] as

Bengtsson, H. The R.oo package - Object-Oriented Programming with References Using
Standard R Code, Proceedings of the 3rd International Workshop on Distributed
Statistical Computing (DSC 2003), ISSN 1609-395X, Hornik, K.; Leisch, F. & Zeileis,
A. (ed.), 2003

License

The releases of this package is licensed under LGPL version 2.1 or newer.

Author(s)

Henrik Bengtsson

References

[1] H. Bengtsson, The R.oo package - Object-Oriented Programming with References Using Standard R Code, In Kurt Hornik, Friedrich Leisch and Achim Zeileis, editors, Proceedings of the 3rd International Workshop on Distributed Statistical Computing (DSC 2003), March 20-22, Vienna, Austria. https://www.r-project.org/conferences/DSC-2003/Proceedings/

See Also

People interested in R.oo may also be interested in packages proto and mutatr.

Creates a standalone finalizer function for Object

Description

Creates a standalone finalizer function for Object, which assumes only that the base package is available.

Usage

.makeObjectFinalizer(this, reloadRoo=TRUE)

Arguments

Details

The created finalizer is reentrant. This is always the case when the R.oo package is already loaded when the finalizer is called. It is also always the case on R v2.15.2 Patched r61487 and beyond. In other cases, the finalizer inspects the call stack (via sys.calls()) to check whether parse() has been called or not. If it is on the call stack, it indicates that parse() triggered the garbage collection, and the R.oo package will not be reloaded in order to avoid risking parse() being called again.

Value

Returns a function that can be passed to reg.finalizer().

8-bit ASCII table

Description

ASCII is the 8-bit ASCII table with ASCII characters from 0-255.

Author(s)

Henrik Bengtsson

See Also

charToInt() intToChar()

Examples

  ch <- ASCII[65+1];  # ch == "A"

A root class like Object but without references

Description

R.oo
Class BasicObject

public class BasicObject

Usage

BasicObject(core=NULL)

Arguments

Fields and Methods

Methods:

Methods inherited from logical:
Ops,nonStructure,vector-method, Ops,structure,vector-method, Ops,vector,nonStructure-method, Ops,vector,structure-method, as.data.frame, as.raster, coerce,ANY,logical-method

Author(s)

Henrik Bengtsson

The Class class describes an Object class

Description

Package: R.oo
Class Class

Object
~~|
~~+--Class

Directly known subclasses:

public static class Class
extends Object

The Class class describes an Object class. First of all, this class is most commonly used internally and neither the end user nor the programmer need to no about the class Class.

Usage

Class(name=NULL, constructor=NULL)

Arguments

Details

The class Class describes the Object class or one of its subclasses. All classes and constructors created by setConstructorS3() will be of class Class. Its methods provide ways of accessing static fields and static methods. Its print() method will print detailed information about the class and its fields and methods.

Fields and Methods

Methods:

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Author(s)

Henrik Bengtsson

Gets the arguments of a function as a character string

Description

Gets the arguments (with default values) of a function as a character string, which can be used for debugging purposes etc. Used by: classinfo().

Usage

## Static method (use this):
## Class$argsToString(fcn, ...)

## Don't use the below:
## S3 method for class 'Class'
argsToString(this, fcn, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

  Class$argsToString(plot)

Gets a Class object by a name of a class

Description

Gets a Class object by a name of a class. If no such class exists and exception is thrown.

Usage

## Static method (use this):
## Class$forName(name, ...)

## Don't use the below:
## S3 method for class 'Class'
forName(static, name, ...)

Arguments

Value

Returns a Class.

Author(s)

Henrik Bengtsson

See Also

class(). setConstructorS3(). For more information see Class.

Examples

  print(Class$forName("Exception"))

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

Description

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

Usage

  ## S3 replacement method for class 'BasicObject'
this$name <- value
  ## S3 replacement method for class 'BasicObject'
this[[name]] <- value

Arguments

set<Name>()

Value

Returns itself, i.e. this, as all $<- methods must do.

Author(s)

Henrik Bengtsson

See Also

For more information see BasicObject.

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

Description

Makes the fields and methods of a Class assignable via the $<- operator. This method is never called explicitly, but through an indirect usage of the $<- operator, e.g. obj$name <- "foo".

1. This method will first search for a

   set<Name>()

   method, e.g. if name has the value "age", a setAge() will be looked for. If such a method exists it will be called with the Class as the first argument and value as the second, e.g. setAge(this, value). A get<Name>() is only looked for if <name> is not a private field. A private field is a name beginning with a . (period). The rational for this naming convention is to be consistent with how ls() works, which will not list such members by default.

2. If no such method exists it will assign the value to a (existing or a non-existing) field named name.

Because any

set<Name>()

is called first, it is possible to encapsulate (hide away) fields with certain names or to put restrictions to what values can be assigned to them.

Usage

  ## S3 replacement method for class 'Class'
this$name <- value
  ## S3 replacement method for class 'Class'
this[[name]] <- value

Arguments

set<Name>()

Value

Returns itself, i.e. this, as all $<- methods must do.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

## Not run: For a complete example see help(Class).

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

Description

Makes the fields and methods of an Object assignable via the $<- operator. This method is never called explicitly, but through an indirect usage of the $<- operator, e.g. obj$name <- "foo".

1) This method will first search for a set<Name>() method, e.g. if name has the value "age", a setAge() will be looked for. If such a method exists it will be called with the Object as the first argument and value as the second, e.g. setAge(this, value).

A set<Name>() is only looked for if <name> is a non-private field. A private field is a name beginning with a . (period). The rational for this naming convention is to be consistent with how ls() works, which will not list such members by default. Moreover, excluding private fields for the search of a set<Name>() will decrease the overhead for such field.

2) If no such method exists the value will be assigned to an existing field named name, if such exists.

3) Otherwise, the value will be assigned to a static field, if such exists.

4) In all other case, the value is assigned to a new field.

Because any set<Name>() is called first, it is possible to encapsulate (hide away) fields with certain names or to put restrictions to what values can be assigned to them.

Usage

  ## S3 replacement method for class 'Object'
this$name <- value
  ## S3 replacement method for class 'Object'
this[[name]] <- value

Arguments

Value

Returns itself, i.e. this, as all $<- methods must do.

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

## Not run: For a complete example see help(Object).

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

Description

Makes the fields and methods of a BasicObject accessible via the $ and the [[ operator.

Usage

  ## S3 method for class 'BasicObject'
this$name
  ## S3 method for class 'BasicObject'
this[[name, exact=TRUE]]

Arguments

Value

Returns the value of a field or a method (function). If no such field or method exists, NULL is returned.

Author(s)

Henrik Bengtsson

See Also

For more information see BasicObject.

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

Description

Makes the fields and methods of a Class accessible via the $ operator. This method is never called explicitly, but through an indirect usage of the $ operator, e.g. obj$name or obj$getValue().

1. This method will first search for a get<Name>() method, e.g. if name has the value "age", a getAge() will be looked for. If such a method exists it will be called with the Class as the first and only argument, e.g. getAge(this). A get<Name>() is only looked for if <name> is not a private field. A private field is a name beginning with a . (period). The rational for this naming convention is to be consistent with how ls() works, which will not list such members by default.

2. If no such method exists, first then, this method will look a field in the Class can has the name name.

3. If such neither exists, a method with name name will be searched for and returned.

4. If no fields or methods are found at all, NULL is returned.

Usage

  ## S3 method for class 'Class'
this$name
  ## S3 method for class 'Class'
this[[name, exact=TRUE]]

Arguments

Value

Returns the value of a field or a method (function). If no such field or method exists, NULL is returned.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

## Not run: For a complete example see help(Class).

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

Description

Makes the fields and methods of an Object accessible via the $ operator. This method is never called explicitly, but through an indirect usage of the $ operator, e.g. obj$name or obj$getValue().

1) This method will first search for a get<Name>() method, e.g. if name has the value "age", a getAge() will be looked for. If such a method exists it will be called with the Object as the first and only argument, e.g. getAge(this).

A get<Name>() is only looked for if <name> is not a private field. A private field is a name beginning with a . (period). The rational for this naming convention is to be consistent with how ls() works, which will not list such members by default.

2) If no such method exists, first then, this method will look a field in the Object can has the name name.

3) If such neither exists, a method with name name will be searched for and returned.

4) Otherwise, a static field will be looked for.

5) If no fields or methods are found at all, NULL is returned.

Usage

  ## S3 method for class 'Object'
this$name
  ## S3 method for class 'Object'
this[[name, exact=TRUE]]

Arguments

Value

Returns the value of a field or a method (function). If no such field or method exists, NULL is returned.

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

## Not run: For a complete example see help(Object).

The Exception class to be thrown and caught

Description

Package: R.oo
Class Exception

Object
~~|
~~+--try-error
~~~~~~~|
~~~~~~~+--condition
~~~~~~~~~~~~|
~~~~~~~~~~~~+--error
~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~+--simpleError
~~~~~~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~~~~~~+--Exception

Directly known subclasses:
InternalErrorException, RccViolationException, RdocException

public static class Exception
extends simpleError

Creates an Exception that can be thrown and caught. The Exception class is the root class of all other Exception classes.

Usage

Exception(..., sep="", collapse=", ")

Arguments

Fields and Methods

Methods:

Methods inherited from error:
as.character, throw

Methods inherited from condition:
abort, as.character, conditionCall, conditionMessage, print

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Author(s)

Henrik Bengtsson

See Also

See also tryCatch() (and try()).

Examples

######################################################################
# 1. To catch a regular "error" exception thrown by e.g. stop().
######################################################################
x <- NA
y <- NA
tryCatch({
  x <- log(123)
  y <- log("a")
}, error = function(ex) {
  print(ex)
})
print(x)
print(y)



######################################################################
# 2. Always run a "final" expression regardless or error or not.
######################################################################
filename <- tempfile("R.methodsS3.example")
con <- file(filename)
tryCatch({
  open(con, "r")
}, error = function(ex) {
  cat("Could not open ", filename, " for reading.\n", sep="")
}, finally = {
  close(con)
  cat("The id of the connection is ",
       ifelse(is.null(con), "NULL", con), ".\n", sep="")
})


######################################################################
# 3. Creating your own Exception class
######################################################################
setConstructorS3("NegativeLogValueException", function(
  msg="Trying to calculate the logarithm of a negative value", value=NULL) {
  extend(Exception(msg=msg), "NegativeLogValueException",
    .value = value
  )
})

setMethodS3("as.character", "NegativeLogValueException", function(this, ...) {
  paste(as.character.Exception(this), ": ", getValue(this), sep="")
})

setMethodS3("getValue", "NegativeLogValueException", function(this, ...) {
  this$.value
})


mylog <- function(x, base=exp(1)) {
  if (x < 0)
    throw(NegativeLogValueException(value=x))
  else
    log(x, base=base)
}


# Note that the order of the catch list is important:
l <- NA
x <- 123
tryCatch({
  l <- mylog(x)
}, NegativeLogValueException = function(ex) {
  cat(as.character(ex), "\n")
}, "try-error" = function(ex) {
  cat("try-error: Could not calculate the logarithm of ", x, ".\n", sep="")
}, error = function(ex) {
  cat("error: Could not calculate the logarithm of ", x, ".\n", sep="")
})
cat("The logarithm of ", x, " is ", l, ".\n\n", sep="")

Static method to get the last Exception thrown

Description

Static method to get the last Exception created.

Usage

## Static method (use this):
## Exception$getLastException(...)

## Don't use the below:
## S3 method for class 'Exception'
getLastException(this, ...)

Arguments

Value

Returns an Exception object.

Author(s)

Henrik Bengtsson

See Also

For more information see Exception. See also tryCatch().

Examples

## Not run: For a complete example see help(Exception).

The Interface class

Description

Package: R.oo
Class Interface

+--Interface

Directly known subclasses:

public class Interface

This class represents a special set of classes whose purpose is to provide methods (but not fields) shared by multiple different classes.

Usage

Interface(core=NA, ...)

Arguments

Methods

Methods:

Author(s)

Henrik Bengtsson

InternalErrorException represents internal errors

Description

Package: R.oo
Class InternalErrorException

Object
~~|
~~+--try-error
~~~~~~~|
~~~~~~~+--condition
~~~~~~~~~~~~|
~~~~~~~~~~~~+--error
~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~+--simpleError
~~~~~~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~~~~~~+--Exception
~~~~~~~~~~~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~~~~~~~~~~~+--InternalErrorException

Directly known subclasses:

public static class InternalErrorException
extends Exception

InternalErrorException represents internal errors that are likely to be due to implementation errors done by the author of a specific package and not because the user made an error. Errors that are due to unexpected input to functions etc falls under this error type.

Usage

InternalErrorException(..., package=NULL)

Arguments

.

Fields and Methods

Methods:

Methods inherited from Exception:
as.character, getCall, getCalls, getLastException, getMessage, getStackTrace, getWhen, print, printStackTrace, throw

Methods inherited from error:
as.character, throw

Methods inherited from condition:
abort, as.character, conditionCall, conditionMessage, print

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Author(s)

Henrik Bengtsson

See Also

For detailed information about exceptions see Exception.

Non-documented objects

Description

This page contains aliases for all "non-documented" objects that R CMD check detects in this package.

Almost all of them are generic functions that have specific document for the corresponding method coupled to a specific class. Other functions are re-defined by setMethodS3() to default methods. Neither of these two classes are non-documented in reality. The rest are deprecated methods.

Author(s)

Henrik Bengtsson

The root class that every class must inherit from

Description

R.oo
Class Object

public class Object

Object is the root class of all other classes. All classes must extends this class, directly or indirectly, which means that they all will inherit the methods in this class.

Usage

Object(core=NA, finalize=TRUE)

Arguments

Fields and Methods

Methods:

Defining static fields

To define a static field of an Object class, use a private field <.field> and then create a virtual field <field> by defining methods get<Field>() and set<Field>(). These methods should retrieve and assign the value of the field <.field> of the static instance of the class. The second example below shows how to do this. The example modifies also the static field already in the constructor, which is something that otherwise may be tricky.

Author(s)

Henrik Bengtsson

References

[1] H. Bengtsson, The R.oo package - Object-Oriented Programming with References Using Standard R Code, In Kurt Hornik, Friedrich Leisch and Achim Zeileis, editors, Proceedings of the 3rd International Workshop on Distributed Statistical Computing (DSC 2003), March 20-22, Vienna, Austria. https://www.r-project.org/conferences/DSC-2003/Proceedings/

Examples

 
#########################################################################
# Defines the class Person with private fields .name and .age, and
# with methods print(), getName(), setName(), getAge() and setAge().
#########################################################################
setConstructorS3("Person", function(name, age) {
  if (missing(name)) name <- NA
  if (missing(age))  age <- NA

  extend(Object(), "Person",
    .name=name,
    .age=age
  )
})


setMethodS3("as.character", "Person", function(this, ...) {
  paste(this$.name, "is", as.integer(this$.age), "years old.")
})

setMethodS3("equals", "Person", function(this, obj, ...) {
  ( identical(data.class(this), data.class(obj)) &&
    identical(this$getName(), obj$getName()) &&
    identical(this$getAge() , obj$getAge() )    )
})

setMethodS3("hashCode", "Person", function(this, ...) {
  # Get the hashCode() of the '.name' and the '.age' fields
  # using hashCode.default().
  hashCode(this$.name) * hashCode(this$.age)
})

setMethodS3("getName", "Person", function(this, ...) {
  this$.name
})

setMethodS3("setName", "Person", function(this, newName, ...) {
  throw("It is not possible to change the name of a Person.")
})

setMethodS3("getAge", "Person", function(this, ...) {
  this$.age
})

setMethodS3("setAge", "Person", function(this, newAge, ...) {
  if (!is.numeric(newAge))
    throw("Age must be numeric: ", newAge)
  if (newAge < 0)
    throw("Trying to set a negative age: ", newAge)
  this$.age <- newAge
})




#########################################################################
# Code demonstrating different properties of the Object class using
# the example class Person.
#########################################################################

# Create an object (instance of) the class Person.
p1 <- Person("Dalai Lama", 67)

# 'p1' is an Object of class Person.
print(data.class(p1))  # "Person"

# Prints information about the Person object.
print(p1)            # "Dalai Lama is 67 years old."

# or equivalent (except that no generic method has to exist):

p1$print()           # "Dalai Lama is 67 years old."

# Shows that no generic method is required if the \$ operator is used:
print(p1$getName())  # "Dalai Lama"

# The following will call p1$getName() since there exists a get-()
# method for the 'name' property.
print(p1$name)       # "Dalai Lama"

# and equivalent when using the [[ operator.
print(p1[["name"]])  # "Dalai Lama"

# The following shows that p1$setName(68) is called, simply because
# there exists a set-() method for the 'name' property.
p1$age <- 68         # Will call p1$setAge(68)

# Shows that the age of the Person has been updated:
print(p1)            # "Dalai Lama is 68 years old."

# If there would not exists such a set-() method or field a new
# field would be created:
p1$country <- "Tibet"

# Lists all (non-private) members of the Person object:
print(ll(p1))

# which gives
#      member class      mode    typeof length  dim bytes
#   1 country  NULL character character      1 NULL    44

# The following will call p1$setName("Lalai Dama") which will
# throw an exception saying one can not change the name of
# a Person.
tryCatch(p1$name <- "Lalai Dama", error=print)

# The following will call p1$setAge(-4) which will throw an
# exception saying that the age must be a non-negative number.
tryCatch(p1$age <- -100, error=print)

# Attaches Object 'p1' to the search path.
attach(p1)

# Accesses the newly created field 'country'.
print(country)       # "Tibet"

# Detaches Object 'p1' from the search path. Note that all
# modifications to 'country' are lost.
country <- "Sweden"
detach(p1)
print(p1$country)    # "Tibet"


# Saves the Person object to a tempory file.
filename <- tempfile("R.methodsS3.example")
save(p1, filename)

# Deletes the object
rm(p1)

# Loads an Object (of "unknown" class) from file using the
# static method load() of class Object.
obj <- Object$load(filename)

# Prints information about the new Object.
print(obj)

# Lists all (non-private) members of the new Object.
print(ll(obj))


 
######################################################################
# Example illustrating how to "emulate" static fields using virtual
# fields, i.e. get- and set-methods.  Here we use a private static
# field '.count' of the static class instance 'MyClass', i.e.
# MyClass$.count.  Then we define a virtual field 'count' via method
# getCount() to access this static field.  This will make all queries
# for 'count' of any object to use the static field instead.  In the
# same way is assignment controlled via the setCount() method.  A
# side effect of this way of coding is that all MyClass instances will
# also have the private field '.count' (set to zero except for the
# static field that is).
######################################################################
setConstructorS3("MyClass", function(...) {
  # Create an instance (the static class instance included)
  this <- extend(Object(), "MyClass",
    .count = 0
  )

  # In order for a static field to be updated in the
  # constructor it has to be done after extend().
  this$count <- this$count + 1

  # Return the object
  this
})


setMethodS3("as.character", "MyClass", function(this, ...) {
  paste(class(this)[1], ": Number of instances: ", this$count, sep="")
})


# Get virtual field 'count', e.g. obj$count.
setMethodS3("getCount", "MyClass", function(this, ...) {
  MyClass$.count
})


# Set virtual field 'count', e.g. obj$count <- value.
setMethodS3("setCount", "MyClass", function(this, value, ...) {
  MyClass$.count <- value
})


# Create four instances of class 'MyClass'
obj <- lapply(1:4, MyClass)
print(obj)
print(MyClass$count)
print(obj[[1]]$count)

stopifnot(obj[[1]]$count == length(obj))
stopifnot(MyClass$count == length(obj))

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

Description

Static method to load an Object from a file or a connection, which previously have been saved using save() of class Object.

Usage

## Static method (use this):
## Object$load(file, path=NULL, ...)

## Don't use the below:
## S3 method for class 'Object'
load(static, file, path=NULL, ...)

Arguments

Details

Please note that no constructors are called when an Object is loaded and neither is any static class code called.

Value

Returns a reference to the loaded Object.

Type control

Typically this static method is called as <Object>$load(...) where <Object> is any Object class. When an Object has been loaded, it is verified that it inherits from <Object>. If it does not, an exception is thrown. Thus, Object$load(...) will load any Object, but MyClass$load(...) will only load an Object that inherits from MyClass. If loaded object is not of correct class, an exception is thrown.

Troubleshooting

Due to a bug, likely in R itself, one can not specify the file argument by its name, i.e. Object$load(file="foo.RData") will not work, but Object$load("foo.RData") work just fine.

Author(s)

Henrik Bengtsson

See Also

*save() and save(), load(). For more information see Object.

Examples

## Not run: For a complete example see help(Object).

The Package class provides methods for accessing package information

Description

Package: R.oo
Class Package

Object
~~|
~~+--Package

Directly known subclasses:

public class Package
extends Object

Creates a Package that can be thrown and caught. The Package class is the root class of all other Package classes.

Usage

Package(name=NULL)

Arguments

Fields and Methods

Methods:

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Author(s)

Henrik Bengtsson

Examples

## Not run: # By defining .onAttach() as follows in zzz.R for a package, an
# instance of class Package with the same name as the package will
# be made available on the search path. More over, the code below
# will also inform the user that the package has been loaded:
#
#  > library(R.oo)
#  R.oo v0.52 (2003/04/13) was successfully loaded.
#
.onAttach <- function(libname, pkgname) {
  pkg <- Package(pkgname)
  assign(pkgname, pkg, pos=getPosition(pkg))
  cat(getName(pkg), " v", getVersion(pkg), " (", getDate(pkg), ")",
    " was successfully loaded.\n", sep="")
}

# The Package class works for any packages, loaded or not.

# Some information about the base package
pkg <- Package("base")
print(pkg)
# [1] "Package: base v3.6.2 is loaded (pos=14).  Title: The R Base Package.
# The official webpage is NA and the maintainer is R Core Team <R-core@
# r-project.org>.  The package is installed in /usr/lib/R/library/base/.
# License: Part of R 3.6.2.  Description: Base R functions.  Type
# showNews(base) for package history, and ?base for help."
print(list.files(Package("base")$dataPath))

# Some information about the R.oo package
print(R.oo::R.oo)
# [1] "Package: R.oo v1.23.0-9000 .  Title: R Object-Oriented Programming
# with or without References.  The official webpage is https://github.com/
# HenrikBengtsson/R.oo and the maintainer is Henrik Bengtsson.  The package
# is installed in /home/alice/R/x86_64-pc-linux-gnu-library/3.6/R.oo/.
# License: LGPL (>= 2.1).  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.  Type showNews(R.oo) for package history,
# and ?R.oo for help."

## End(Not run)

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

Description

Package: R.oo
Class RccViolationException

Object
~~|
~~+--try-error
~~~~~~~|
~~~~~~~+--condition
~~~~~~~~~~~~|
~~~~~~~~~~~~+--error
~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~+--simpleError
~~~~~~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~~~~~~+--Exception
~~~~~~~~~~~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~~~~~~~~~~~+--RccViolationException

Directly known subclasses:

public static class RccViolationException
extends Exception

An RccViolationException indicates a violation of the R Coding Conventions (RCC). It is generated by setConstructorS3() and setMethodS3(). It is not meant to be caught, but instead the source code that violates the RCC should be fixed. For more information about RCC, see references below.

Usage

RccViolationException(...)

Arguments

Details

Since it is not possible to assert that the RCC is followed during the parsing of the source code, but first only when the source code is actually executed.

Fields and Methods

Methods:

Methods inherited from Exception:
as.character, getCall, getCalls, getLastException, getMessage, getStackTrace, getWhen, print, printStackTrace, throw

Methods inherited from error:
as.character, throw

Methods inherited from condition:
abort, as.character, conditionCall, conditionMessage, print

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Author(s)

Henrik Bengtsson

See Also

See also try() and tryCatch(). For detailed information about exceptions see Exception. The R Coding Conventions (RCC) can be found at https://aroma-project.org/developers/RCC/.

Examples

 ## Not run: 
  setConstructorS3("myClass", function() { extends(Object(), .value=0) })
  setMethodS3("MyMethod", "myClass", function(this) { "Hullo!" })
 
## End(Not run)

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

Description

Static method to get a URL where one can find details about the R Code Convention (RCC). Currently the URL is https://aroma-project.org/developers/RCC/.

Usage

## Static method (use this):
## RccViolationException$getRccUrl(...)

## Don't use the below:
## S3 method for class 'RccViolationException'
getRccUrl(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see RccViolationException.

Examples

## Not run: For a complete example see help(RccViolationException).

Class for converting Rdoc comments to Rd files

Description

Package: R.oo
Class Rdoc

Object
~~|
~~+--Rdoc

Directly known subclasses:

public static class Rdoc
extends Object

Class for converting Rdoc comments to Rd files.

Usage

Rdoc()

Fields and Methods

Methods:

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Author(s)

Henrik Bengtsson

References

R developers, Guidelines for Rd files, https://developer.r-project.org/Rds.html, 2003

Examples

## Not run: # Set default author
author <- "Henrik Bengtsson, \url{https://github.com/HenrikBengtsson/R.oo}"

# Show the file containing the Rdoc comments
rdocFile <- system.file("misc", "ASCII.R", package="R.oo")
file.show(rdocFile)

# Compile the Rdoc:s into Rd files (saved in the destPath directory)
destPath <- tempdir()
Rdoc$compile(rdocFile, destPath=destPath)

# List the generated Rd files
rdFiles <- list.files(destPath, full.names=TRUE)
print(rdFiles)

# Show one of the files
file.show(rdFiles[1])

# Clean up
file.remove(rdFiles)

## End(Not run)

Gets the arguments signature of a function

Description

Gets the arguments signature of a function.

Usage

## Static method (use this):
## Rdoc$argsToString(fcn, escapeRd=FALSE, collapse=TRUE, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
argsToString(static, fcn, escapeRd=FALSE, collapse=TRUE, ...)

Arguments

Value

Returns a list of character strings.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Compile source code files containing Rdoc comments into Rd files

Description

Compile source code files containing Rdoc comments into Rd files.

Note, the class and methods to be compiled have to be loaded into R by for instance library() or source() before calling this method.

Usage

## Static method (use this):
## Rdoc$compile(filename=".*[.]R$", destPath=getManPath(this), showDeprecated=FALSE,
##   addTimestamp=FALSE, locale="C", verbose=FALSE, source=FALSE, check=TRUE,
##   debug=FALSE, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
compile(this, filename=".*[.]R$", destPath=getManPath(this), showDeprecated=FALSE,
  addTimestamp=FALSE, locale="C", verbose=FALSE, source=FALSE, check=TRUE, debug=FALSE,
  ...)

Arguments

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Creates the directory where the Rd files should be saved

Description

Creates the directory where the Rd files should be saved.

Usage

## Static method (use this):
## Rdoc$createManPath(...)

## Don't use the below:
## S3 method for class 'Rdoc'
createManPath(this, ...)

Arguments

Value

Returns TRUE if the directory was creates, FALSE if it already exists and throws an Exception if failed.

Author(s)

Henrik Bengtsson

See Also

*getManPath() For more information see Rdoc.

Creates a class-method name

Description

Creates a class-method name.

Usage

## Static method (use this):
## Rdoc$createName(class, method, escape=TRUE, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
createName(static, class, method, escape=TRUE, ...)

Arguments

Value

Returns character string.

Author(s)

Henrik Bengtsson

See Also

*escapeRdFilename(). For more information see Rdoc.

Gets the class declaration

Description

Gets the class declaration.

Usage

## Static method (use this):
## Rdoc$declaration(class, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
declaration(this, class, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Escape non-valid characters in a filename

Description

Escape non-valid characters in a filename.

Usage

## Static method (use this):
## Rdoc$escapeRdFilename(filename, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
escapeRdFilename(static, filename, ...)

Arguments

Value

Returns character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Gets the usage of a S4 class

Description

Gets the usage of a S4 class.

Usage

## Static method (use this):
## Rdoc$getClassS4Usage(class, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
getClassS4Usage(static, class, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Gets the keywords defined in R with descriptions

Description

Gets the keywords defined in R with descriptions.

Usage

## Static method (use this):
## Rdoc$getKeywords(fullInfo=FALSE, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
getKeywords(this, fullInfo=FALSE, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

*setManPath() For more information see Rdoc.

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

Description

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

Usage

## Static method (use this):
## Rdoc$getManPath(...)

## Don't use the below:
## S3 method for class 'Rdoc'
getManPath(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

*setManPath() For more information see Rdoc.

Gets the current name format

Description

Gets the current name format.

Usage

## Static method (use this):
## Rdoc$getNameFormat(...)

## Don't use the below:
## S3 method for class 'Rdoc'
getNameFormat(static, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

*setNameFormat() For more information see Rdoc.

Gets the package of a method or an object

Description

Gets the package of a method or an object.

Usage

## Static method (use this):
## Rdoc$getPackageNameOf(objectName, mode="any", unique=TRUE, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
getPackageNameOf(static, objectName, mode="any", unique=TRUE, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Extracts the title string of a Rd file

Description

Extracts the title string of a Rd file corresponding the the specified method of the specified class.

Usage

## Static method (use this):
## Rdoc$getRdTitle(class, method, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
getRdTitle(this, class, method, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Gets the usage of a method

Description

Gets the usage of a method.

Usage

## Static method (use this):
## Rdoc$getUsage(method, class=NULL, wrap=90L, indent=2L, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
getUsage(static, method, class=NULL, wrap=90L, indent=2L, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Gets the class hierarchy

Description

Gets the class hierarchy.

Usage

## Static method (use this):
## Rdoc$hierarchy(class, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
hierarchy(this, class, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Checks if a word is a Rd keyword

Description

Checks if a word is a Rd keyword.

Usage

## Static method (use this):
## Rdoc$isKeyword(word, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
isKeyword(this, word, ...)

Arguments

Value

Returns a logical.

Author(s)

Henrik Bengtsson

See Also

*getKeywords() For more information see Rdoc.

Checks if a member is visible given its modifiers

Description

Checks if a member is visible given its modifiers.

Usage

## Static method (use this):
## Rdoc$isVisible(modifiers, visibilities, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
isVisible(static, modifiers, visibilities, ...)

Arguments

Value

Returns TRUE if the modifiers are equal or higher than the visibility flags, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Gets all methods inherited from a class in Rd format

Description

Gets all methods inherited from a class in Rd format.

Usage

## Static method (use this):
## Rdoc$methodsInheritedFrom(class, visibility=c("public", "protected", "private"),
##   showDeprecated=FALSE, inheritedFrom=NULL, sort=TRUE, trial=FALSE, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
methodsInheritedFrom(this, class, visibility=c("public", "protected", "private"),
  showDeprecated=FALSE, inheritedFrom=NULL, sort=TRUE, trial=FALSE, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

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

Description

Sets the path to the directory where the Rd files should be saved. By default the path is ../man/ assuming that the current directory is ../R/, which is where source files commonly are placed.

Usage

## Static method (use this):
## Rdoc$setManPath(path="../man/", ...)

## Don't use the below:
## S3 method for class 'Rdoc'
setManPath(this, path="../man/", ...)

Arguments

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

*getManPath() For more information see Rdoc.

Sets the current name format

Description

Sets the current name format. Throws a RccViolationException if an unknown format is requested.

Usage

## Static method (use this):
## Rdoc$setNameFormat(nameFormat, ...)

## Don't use the below:
## S3 method for class 'Rdoc'
setNameFormat(static, nameFormat, ...)

Arguments

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

*getNameFormat() For more information see Rdoc.

RdocException are thrown by the Rdoc compiler

Description

Package: R.oo
Class RdocException

Object
~~|
~~+--try-error
~~~~~~~|
~~~~~~~+--condition
~~~~~~~~~~~~|
~~~~~~~~~~~~+--error
~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~+--simpleError
~~~~~~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~~~~~~+--Exception
~~~~~~~~~~~~~~~~~~~~~~~~~~~|
~~~~~~~~~~~~~~~~~~~~~~~~~~~+--RdocException

Directly known subclasses:

public static class RdocException
extends Exception

RdocException are thrown by the Rdoc compiler when it fails to generate a Rd file from an Rdoc comment.

Usage

RdocException(..., source=NULL)

Arguments

.

.

Fields and Methods

Methods:

Methods inherited from Exception:
as.character, getCall, getCalls, getLastException, getMessage, getStackTrace, getWhen, print, printStackTrace, throw

Methods inherited from error:
as.character, throw

Methods inherited from condition:
abort, as.character, conditionCall, conditionMessage, print

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save

Author(s)

Henrik Bengtsson

See Also

For detailed information about exceptions see Exception.

Aborts the current expression call

Description

Aborts the current expression call and returns to the top level prompt/browser without signaling a condition.

Usage

## Default S3 method:
abort(..., call.=TRUE, domain=NULL)

Arguments

Details

There are still cases where one can "catch" the abort and undo it, cf. [1].

Value

Returns nothing.

Author(s)

Henrik Bengtsson

References

[1] R-devel thread ”, Sept 11, 2012, https://stat.ethz.ch/pipermail/r-devel/2012-September/064838.html.

See Also

throw(). stop(). Internally, invokeRestart()("abort") is utilized.

Examples

## Not run: 
 foo <- function() {
  cat("foo()...\n")
  on.exit(cat("foo()...done\n"))
  tryCatch({
    stop("Woops!")
  }, error = function(ex) {
    cat("An error was caught: ", ex$message, "\n", sep="")
  })
  cat("Continuing...\n")
}

bar <- function() {
  cat("bar()...\n")
  on.exit(cat("bar()...done\n"))
  tryCatch({
    abort("Woops!")
  }, error = function(ex) {
    cat("An error was caught: ", ex$message, "\n", sep="")
  })
  cat("This message will never be displayed...\n")
}

# An error generated by stop() can be caught
foo()

# ...which is not possible when using abort()
bar()

# This expression is never reached
cat("This line will never be outputted.\n")


## End(Not run)

Gets a character string representing the object

Description

Gets a character string representing the object.

Usage

## S3 method for class 'BasicObject'
as.character(x, ...)

Value

Returns a character string representation of the object.

Author(s)

Henrik Bengtsson

See Also

For more information see BasicObject.

Returns a short string describing the class

Description

Returns a short string describing the class.

Usage

## S3 method for class 'Class'
as.character(x, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

  print(as.character(Object))

  # gives:  "Class Object: no fields, 8 methods (no inherited)"

Gets a character string representing of the Exception

Description

. By default the format is: "[{POSIX date string}] {class name}: {msg}".

Usage

## S3 method for class 'Exception'
as.character(x, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Exception.

Examples

## Not run: For a complete example see help(Exception).

Gets a character string representing the Interface

Description

Gets a character string representing the Interface.

Usage

## S3 method for class 'Interface'
as.character(x, ...)

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Interface.

Gets a character string representing the object

Description

Gets a character string representing the object. In the class Object, this method simply returns the class name and the hashCode() value of the object.

Usage

## S3 method for class 'Object'
as.character(x, ...)

Arguments

Value

Returns a character string representation of the Object. By default it is "{class name}: {hash code}".

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

  obj <- Object()
  as.character(obj)    # "Object: 0x000000000ab6a7a8"

Gets a string representation of this package

Description

Gets a string representation of this package.

Usage

## S3 method for class 'Package'
as.character(x, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

print(R.oo)

Gets a string representing of the RCC violation

Description

Gets a string representing of the RCC violation of format "[{POSIX date string}] {class name}: {msg}, cf. https://aroma-project.org/developers/RCC/".

Usage

## S3 method for class 'RccViolationException'
as.character(x, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see RccViolationException.

Examples

## Not run: For a complete example see help(Exception).

Gets a character string representing of the RdocException

Description

.

Usage

## S3 method for class 'RdocException'
as.character(x, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see RdocException.

Attach a BasicObject to the R search path

Description

Attach the members of a BasicObject to the R search path.

If trying to attach the same BasicObject twice without detaching it in between, a warning will be generated and nothing will be done.

Usage

## S3 method for class 'BasicObject'
attach(this, private=FALSE, pos=2, ...)

Arguments

Value

Returns TRUE if the BasicObject was attached, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

*detach() and attach(), detach(). For more information see BasicObject.

Attaches an Object to the R search path

Description

Attach the members of an Object to the R search path.

If trying to attach the same Object twice without detaching it in between, a warning will be generated and nothing will be done.

Usage

## S3 method for class 'Object'
attach(this, private=FALSE, pos=2, ...)

Arguments

Value

Returns TRUE if the Object was attached, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

*detach() and attach(), detach(). For more information see Object.

Examples

## Not run: For a complete example see help(Object).

Attaches an Object locally to an environment

Description

Attaches an Object locally to an environment. By default, the fields of the Object are attached to the parent frame, that is, the calling environment.

Usage

## S3 method for class 'Object'
attachLocally(this, private=FALSE, fields=NULL, excludeFields=NULL, overwrite=TRUE,
  envir=parent.frame(), ...)

Arguments

Value

Returns (invisibly) a character vector of the fields copied.

Author(s)

Henrik Bengtsson

See Also

*attach() For more information see Object.

Examples

foo <- function(object, arg1="some value", ...) {
  cat("Local objects in foo():\n")
  print(ls())

  attachLocally(object)

  cat("\nLocal objects in foo():\n")
  print(ls())

  for (name in ls()) {
    cat("\nObject '", name, "':\n", sep="")
    print(get(name, inherits=FALSE))
  }
}

a <- "A string"
obj <- Object()
obj$a <- "Another string"
obj$b <- NA
foo(obj)
print(a)

Converts a vector of ASCII characters into a vector of integers

Description

Converts a vector of ASCII characters to a equal length vector of ASCII integers.

Usage

## Default S3 method:
charToInt(ch, ...)

Arguments

Value

Returns an ASCII integer vector.

Author(s)

Henrik Bengtsson

See Also

intToChar() utf8Conversion. rawConversion

Examples

  i <- charToInt(unlist(strsplit("Hello world!", split=NULL)))
  # Gives: 72 101 108 108 111  32 119 111 114 108 100  33
  ch <- intToChar(c(72,101,108,108,111,32,119,111,114,108,100,33))
  # Gives: "H" "e" "l" "l" "o" " " "w" "o" "r" "l" "d" "!"

Checks the compiled Rd files

Description

Checks the compiled Rd files.

Usage

## S3 method for class 'Rdoc'
check(this, manPath=getManPath(this), verbose=FALSE, ...)

Arguments

Details

Internally the tools package is used.

Value

Returns a printable object, which, if non-empty will show the errors.

Author(s)

Henrik Bengtsson

See Also

For more information see Rdoc.

Clear fields that are defined to have cached values

Description

Clear fields that are defined to have cached values by assigning NULL to these fields.

Usage

## S3 method for class 'Object'
clearCache(this, recursive=TRUE, gc=FALSE, ...)

Arguments

Value

Returns itself (invisible).

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Defining a class with a 'cached' fields
# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
setConstructorS3("CachedObject", function(...) {
  extend(Object(), "CachedObject",
    ...
  )
})

setMethodS3("as.character", "CachedObject", function(this, ...) {
  s <- NextMethod("as.character", this, ...)
  s <- sprintf("%s RAM: %.2fkb.", s, objectSize(this)/1024)
  s
})


# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Example of clearing a cache fields, reassigning it,
# and then clearing it again
# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
obj <- CachedObject(a=1, b=1:10^5, "cached:c"=1:10^6)
print(obj)
print(ll(obj))

clearCache(obj, gc=TRUE)
print(obj)
print(ll(obj))


obj$c <- 1:10^6
print(obj)
print(ll(obj))

clearCache(obj, gc=TRUE)
print(obj)
print(ll(obj))


# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Clearing cached fields recursively and make sure it
# avoids race conditions due to circular dependences
# - - - - - - - - - - - - - - - - - - - - - - - - - - - -
objA <- CachedObject(a=2, "cached:c"=1:10^6, prev=NULL)
print(ll(objA))

objB <- CachedObject(a=2, "cached:c"=1:10^6, prev=objA)
print(ll(objB))

objC <- CachedObject(a=3, "cached:c"=1:10^6, prev=objB)
print(ll(objC))

objA$prev <- objC

clearCache(objA, gc=TRUE)
print(ll(objA))
print(ll(objB))
print(ll(objC))

Clear internal fields used for faster lookup

Description

Clear internal fields used for faster lookup by removing these fields. This method is called whenever *clearCache() is called on the object.

Usage

## S3 method for class 'Object'
clearLookupCache(this, ...)

Arguments

Value

Returns itself (invisible).

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Clones an Object

Description

Creates an identical copy of the object and returns a reference to the new object.

Usage

## S3 method for class 'Object'
clone(this, ...)

Arguments

Details

Please note that no constructors are called during the creation of the clone and neither is any static class code called.

Value

A reference to the new object.

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

  o1 <- Object()
  o2 <- clone(o1)

  print(equals(o1, o2))

Compiles the Rdoc help comments in a package

Description

Compiles the Rdoc help comments in a package by parsing the source code files and writes Rd help files.

Usage

compileRdoc(pkgname=NULL, path=pkgname, ..., verbose=TRUE)

Arguments

Details

To compile all Rdoc comments in a package 'PkgA' that is located under the current working directory (e.g. PkgA/R/*.R) from the system command line, do:

    Rscript -e R.oo::compileRdoc()
  

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

See the Rdoc class.

Detach a BasicObject from the R search path

Description

Detach, from the R search path, a BasicObject that has previously been attached. If the BasicObject was not attached, a warning will be generated and nothing will be done.

Usage

## S3 method for class 'BasicObject'
detach(this, ...)

Arguments

Value

Returns TRUE if the BasicObject was detached, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

*attach() and attach(), detach(). For more information see BasicObject.

Detach an Object from the R search path

Description

Detach, from the R search path, an Object that has previously been attached. If the Object was not attached, a warning will be generated and nothing will be done.

Usage

## S3 method for class 'Object'
detach(this, ...)

Arguments

Value

Returns TRUE if the Object was detached, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

*attach() and attach(), detach(). For more information see Object.

Examples

## Not run: For a complete example see help(Object).

Gets the dimension of the object

Description

Gets the dimension of the object similar to what dim() does, but instead of NULL it will return the length of a vector. If a function is passed, NULL is returned.

Usage

## Default S3 method:
dimension(object, ...)

Arguments

Value

Returns an integer vector or NULL.

Author(s)

Henrik Bengtsson

See Also

ll.default(). dim() and length().

Examples

  dimension(matrix(1:100, ncol=10))     # 10 10
  dimension(1:14)                       # 14
  dimension(data.frame(a=1:10, b=10:1)) # 10  2
  dimension(print)                      # NULL

Compares an object with another

Description

Compares an object with another and returns TRUE if they are equal. The equal property must be

1) reflexive, i.e. equals(o1,o1) should be TRUE.

2) symmetric, i.e. equals(o1,o2) is TRUE if and only if equals(o2,o1) is TRUE.

3) transitive, i.e. equals(o1,o2) is TRUE and equals(o2,o3) is TRUE, then equals(o1,o3) should be TRUE.

5) consistent, i.e. equals(o1,o2) should return the same result on multiple invocations as long as nothing has changed.

6) equals(o1,NULL) should return FALSE, unless o1 is also NULL.

By default identical() is used.

Usage

## Default S3 method:
equals(object, other, ...)

Arguments

Value

Returns TRUE if the objects are equal, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

identical().

Compares an object with another

Description

Compares an object with another and returns TRUE if they are equal. The equal property must be

1) reflexive, i.e. equals(o1,o1) should be TRUE.

2) symmetric, i.e. equals(o1,o2) is TRUE if and only if equals(o2,o1) is TRUE.

3) transitive, i.e. equals(o1,o2) is TRUE and equals(o2,o3) is TRUE, then equals(o1,o3) should be TRUE.

5) consistent, i.e. equals(o1,o2) should return the same result on multiple invocations as long as noting has changed.

6) equals(o1,NULL) should return FALSE.

By default, the method returns TRUE if and only if the two references compared refer to the same BasicObject, i.e. ( !is.null(obj) && (hashCode(this) == hashCode(obj)) ).

Usage

## S3 method for class 'BasicObject'
equals(this, other, ...)

Arguments

Value

Returns TRUE if the objects are equal, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

For more information see BasicObject.

Compares an object with another

Description

Compares an object with another and returns TRUE if they are equal. The equal property must be

1) reflexive, i.e. equals(o1,o1) should be TRUE.

2) symmetric, i.e. equals(o1,o2) is TRUE if and only if equals(o2,o1) is TRUE.

3) transitive, i.e. equals(o1,o2) is TRUE and equals(o2,o3) is TRUE, then equals(o1,o3) should be TRUE.

5) consistent, i.e. equals(o1,o2) should return the same result on multiple invocations as long as nothing has changed.

6) equals(o1,NULL) should return FALSE, unless o1 is also NULL.

By default, the method returns TRUE if and only if the two references compared refer to the same Object, i.e. ( !is.null(obj) && (hashCode(this) == hashCode(obj)) ).

Usage

## S3 method for class 'Object'
equals(this, other, ...)

Arguments

Value

Returns TRUE if the Object's are equal, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

*hashCode(). For more information see Object.

Examples

  o1 <- Object()
  o2 <- clone(o1)
  equals(o1, o1)    # TRUE
  equals(o1, o2)    # FALSE

Extends a object

Description

via a mechanism known as "parasitic inheritance". Simply speaking this method "extends" the class of an object. What is actually happening is that it creates an instance of class name ...className, by taking another object and add ...className to the class list and also add all the named values in ... as attributes.

The method should be used by the constructor of a class and nowhere else.

Usage

## Default S3 method:
extend(this, ...className, ...)

Arguments

Value

Returns an object of class ...className.

Author(s)

Henrik Bengtsson

Examples

setConstructorS3("MyDouble", function(value=0, ...) {
  extend(as.double(value), "MyDouble", ...)
})

setMethodS3("as.character", "MyDouble", function(object, ...) {
  fmtstr <- attr(object, "fmtstr")
  if (is.null(fmtstr))
    fmtstr <- "%.6f"
  sprintf(fmtstr, object)
})

setMethodS3("print", "MyDouble", function(object, ...) {
  print(as.character(object), ...)
})

x <- MyDouble(3.1415926)
print(x)

x <- MyDouble(3.1415926, fmtstr="%3.2f")
print(x)
attr(x, "fmtstr") <- "%e"
print(x)






setConstructorS3("MyList", function(value=0, ...) {
  extend(list(value=value, ...), "MyList")
})

setMethodS3("as.character", "MyList", function(object, ...) {
  fmtstr <- object$fmtstr
  if (is.null(fmtstr))
    fmtstr <- "%.6f"
  sprintf(fmtstr, object$value)
})

setMethodS3("print", "MyList", function(object, ...) {
  print(as.character(object), ...)
})

x <- MyList(3.1415926)
print(x)
x <- MyList(3.1415926, fmtstr="%3.2f")
print(x)
x$fmtstr <- "%e"
print(x)

Extends another class

Description

via a mechanism known as "parasitic inheritance". Simply speaking this method "extends another class". What is actually happening is that it creates an instance of class name ...className, by taking another BasicObject instance and add ...className to the class list and also add all the named values in ... as fields to the new instance.

The method should be used by the constructor of a class and nowhere else.

Usage

## S3 method for class 'BasicObject'
extend(this, ...className, ...)

Arguments

Value

Returns a BasicObject of class className.

Author(s)

Henrik Bengtsson

See Also

For more information see BasicObject.

Extends another Interface class

Description

Extends another Interface class.

Usage

## S3 method for class 'Interface'
extend(this, ...className, ...)

Arguments

Value

Returns an Interface of class className.

Author(s)

Henrik Bengtsson

See Also

For more information see Interface.

Extends another class

Description

via a mechanism known as "parasitic inheritance". Simply speaking this method "extends another class". What is actually happening is that it creates an instance of class name ...className, by taking another Object instance and add ...className to the class list and also add all the named values in ... as fields to the new instance.

The method should be used by the constructor of a class and nowhere else.

Usage

## S3 method for class 'Object'
extend(this, ...className, ..., ...fields=NULL, ...envir=parent.frame(), ...finalize=NA)

Arguments

Details

The reason for the strange name of argument "...className" is that if one tries to set a field with a name that is a prefix of the name of this arguments and one at the same time does not specify the name of this argument one would run into strange errors. For instance, try extend(Object(), "MyClass", ...c=0).

Value

Returns an Object of class className.

Field modifiers

It is possible to specify modifiers to some of the fields. Currently it is only the cached modifier that is recognized. A field that is cached will be assigned NULL when *clearCache() is called. To specify a modifier, append a comma separated list of modifiers followed by a colon, e.g. "cached:foo".

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

## Not run: For a complete example see help(Object).

Finalizer methods called when object is clean out

Description

Finalizer methods are called just the moment before the object is about to be deleted by the garbage collector.

If creating a custom finalize() method for a subclass in a package, then it needs to be exported in the NAMESPACE of that package. If not, it will not be found nor called and there will be no error message.

A finalizer method should never be called explicitly!

Usage

## S3 method for class 'Object'
finalize(this, ...)

Arguments

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

setConstructorS3("MyClass", function() {
  extend(Object(), "MyClass")
})

setMethodS3("finalize", "MyClass", function(this, ...) {
  cat(as.character(this), "is about to be removed from the memory!\n")
})

o <- MyClass()
o <- MyClass()
o <- MyClass()
o <- MyClass()
gc()

## MyClass: 0x01BE602C is about to be removed from the memory!
## MyClass: 0x01BFF634 is about to be removed from the memory!
## MyClass: 0x01C13584 is about to be removed from the memory!
##          used (Mb) gc trigger (Mb)
## Ncells 229903  6.2     467875 12.5
## Vcells  53725  0.5     786432  6.0

rm(o)
## MyClass: 0x01C578B0 is about to be removed from the memory!
##          used (Mb) gc trigger (Mb)
## Ncells 229903  6.1     467875 12.3
## Vcells  53725  0.5     786432  6.0

Gets the Author of this package

Description

Gets the Author of this package as specified by the DESCRIPTION file.

Usage

## S3 method for class 'Package'
getAuthor(this, as=c("character", "person"), include=c("given", "family"), ...)

Arguments

Value

Returns a character string or a person object.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getAuthor(pkg))

Gets the Bundle that this package might belong to

Description

Gets the Bundle that this package might belong to as specified by the DESCRIPTION file.

Usage

## S3 method for class 'Package'
getBundle(this, ...)

Arguments

Details

The first call to this method is normally slow because all installed packages are scanned. The result of this first call is cached and used as the return value for all subsequent calls, which are then much faster.

Value

If the package is part of a bundle, the name of the bundle is returned. Otherwise, NULL is returned.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getBundle(pkg))

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

Description

Gets the names of the other packages that is in the same bundle as this package as specified by the DESCRIPTION file.

Usage

## S3 method for class 'Package'
getBundlePackages(this, ...)

Arguments

Details

The first call to this method is normally slow because all installed packages are scanned. The result of this first call is cached and used as the return value for all subsequent calls, which are then much faster.

Value

Returns a character vector of package names or NULL.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getBundle(pkg))

Gets the active calls saved when the exception was created

Description

.

Usage

## S3 method for class 'Exception'
getCalls(this, ...)

Arguments

Value

Returns an unnamed list with @language elements.

Author(s)

Henrik Bengtsson

See Also

*getStackTrace(). sys.calls(). For more information see Exception.

Examples

## Not run: For a complete example see help(Exception).

Gets the change log of this package

Description

Gets the change log of this package, that is, (by default) the NEWS (then the HISTORY and ChangeLog) file, which should is expected to be located in the root directory of the package, i.e. *getPath().

Usage

## S3 method for class 'Package'
getChangeLog(this, filenames=c("NEWS", "HISTORY", "ChangeLog"), newline="\n", ...)

Arguments

Value

Returns the complete contents of the change log file as a character string. If not found, NULL is returned.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Gets all classes of a package

Description

Gets all classes of a package.

Usage

## S3 method for class 'Package'
getClasses(this, ...)

Arguments

Value

Returns a character vector of class names.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getClasses(pkg))

Get a constructor method

Description

Get a constructor method.

Usage

## Default S3 method:
getConstructorS3(name, ...)

Arguments

Author(s)

Henrik Bengtsson

See Also

setConstructorS3(). getMethodS3. isGenericS3.

Gets the contents of this package

Description

Gets the contents of this package, i.e. the parsed CONTENTS file.

Usage

## S3 method for class 'Package'
getContents(this, fields=NULL, ...)

Arguments

Value

Returns a data.frame.

Author(s)

Henrik Bengtsson

See Also

dcf. For more information see Package.

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

Description

Gets the URL(s) from where this package can be installed by first looking for comma or semicolon separated URLs at the optional ContribURL line in the DESCRIPTION file of the package. If no such line exists, getUrl() is used.

Usage

## S3 method for class 'Package'
getContribUrl(this, ...)

Arguments

Value

Returns a vector of character strings.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getContribUrl(pkg))

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

Description

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

Usage

## S3 method for class 'Package'
getDataPath(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Gets the date when package was build

Description

Checks if the package is loaded onto the search path or not.

Usage

## S3 method for class 'Package'
getDate(this, ...)

Arguments

Value

TRUE if the packages has been loaded, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("base")
  print(isLoaded(pkg))       # TRUE

Gets the description of the package

Description

Gets the description of the package. Not to be mixed up with *getDescriptionFile().

Usage

## S3 method for class 'Package'
getDescription(this, replaceNewlines=" ", ...)

Arguments

Value

A character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("base")
  print(getDescription(pkg))

Gets the description file of this package

Description

Gets the description file of this package, i.e. the parsed DESCRIPTION file.

Usage

## S3 method for class 'Package'
getDescriptionFile(this, fields=NULL, ...)

Arguments

Value

Returns named vector of character strings.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Lists the fields and methods of a class

Description

Lists the fields and methods of a class (or an object).

Usage

## S3 method for class 'Class'
getDetails(this, private=FALSE, ...)

Arguments

Value

Returns an invisible character string of the class information.

Author(s)

Henrik Bengtsson

Examples

  getDetails(Exception)

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

Description

Gets the URL(s) from where the developers version of this package can be installed by looking for comma or semicolon separated URLs at the optional DevelURL line in the DESCRIPTION file of the package.

Usage

## S3 method for class 'Package'
getDevelUrl(this, ...)

Arguments

Value

Returns a vector of character strings.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getDevelUrl(pkg))

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

Description

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

Usage

## S3 method for class 'Package'
getDocPath(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  print(list.files(getDocPath(R.oo)))   # explicit call, or
  print(list.files(R.oo$docPath))       # as a virtual field

Gets the environment of this object

Description

Gets the environment of this object. This is the environment where the members of the Object are stored.

Usage

## S3 method for class 'Object'
getEnvironment(fun, ...)

Arguments

Value

Returns an environment.

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

  ll(R.oo)
  ll(envir=getEnvironment(R.oo))

Gets the environment of a loaded package

Description

Gets the environment of a loaded package.

Usage

## S3 method for class 'Package'
getEnvironment(this, ...)

Arguments

Value

Returns a environment, or NULL if the package was not loaded.

Author(s)

Henrik Bengtsson

See Also

*getPosition(). For more information see Package.

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

Description

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

Usage

## S3 method for class 'Package'
getExamplePath(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Gets all types of field modifiers

Description

Gets all types of field modifiers, if any.

Usage

## S3 method for class 'Object'
getFieldModifiers(this, ...)

Arguments

Value

Returns a named list.

Author(s)

Henrik Bengtsson

Returns the field names of a BasicObject

Description

Returns the field names of a BasicObject.

Usage

## S3 method for class 'BasicObject'
getFields(this, private=FALSE, ...)

Arguments

Value

Returns a character vector of field names.

Author(s)

Henrik Bengtsson

See Also

To check if a field exists or not, see *hasField(). For more information see BasicObject.

Returns the field names of a class

Description

Returns the field names of a class.

Usage

## S3 method for class 'Class'
getFields(this, private=FALSE, ...)

Arguments

Value

Returns a character vector of field names.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

  print(getFields(Exception))

Returns NULL

Description

Returns NULL.

Usage

## S3 method for class 'Interface'
getFields(...)

Arguments

Value

Always returns NULL.

Author(s)

Henrik Bengtsson

See Also

For more information see Interface.

Returns the field names of an Object

Description

Returns the field names of an Object.

Usage

## S3 method for class 'Object'
getFields(this, private=FALSE, ...)

Arguments

Value

Returns a character vector of field names.

Author(s)

Henrik Bengtsson

See Also

To check if a field exists or not, see *hasField(). For more extensive information about the fields in an Object see *ll(). For more information see Object.

Examples

  obj <- Object()
  obj$x <- 1:100
  obj$y <- 100:1
  getFields(obj)

  ## Not run: 
  gives:

  [1] "x" "y"
  
## End(Not run)

Gets the citation of this package

Description

Gets the citation of this package. If text file HOWTOCITE exists in package root directory, then its contents is retrieved, otherwise citation for the package is retrieved.

Usage

## S3 method for class 'Package'
getHowToCite(this, newline="\n", ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Gets the time when the object was instantiated

Description

Gets the time when the object was instantiated (created) as a POSIXt object.

Usage

## S3 method for class 'BasicObject'
getInstantiationTime(this, ...)

Arguments

Details

The instantiation timestamp is set when the object is created, and only of option "R.oo::BasicObject/instantiationTime" is TRUE.

Value

Returns a POSIXt object, which extends class POSIXct.

Author(s)

Henrik Bengtsson

See Also

For more about time formats and POSIX see DateTimeClasses. For more information see BasicObject.

Gets the time when the object was instantiated

Description

Gets the time when the object was instantiated (created) as a POSIXt object.

Usage

## S3 method for class 'Object'
getInstantiationTime(this, ...)

Arguments

Details

The instantiation time stamp is set when the object is created, and only of option "R.oo::BasicObject/instantiationTime" is TRUE.

Value

Returns a POSIXt object, which extends class POSIXct.

Author(s)

Henrik Bengtsson

See Also

For more about time formats and POSIX see DateTimeClasses. For more information see Object.

Examples

  oopts <- options("R.oo::Object/instantiationTime"=TRUE)
  obj <- Object()
  print(getInstantiationTime(obj))
  options(oopts)

Gets the memory location where the Object resides

Description

Gets the memory location where the Object resides.

Usage

## S3 method for class 'Object'
getInternalAddress(this, format=c("numeric", "hexstring"), ...)

Arguments

Value

The address is returned as a numeric integer if format == "numeric", and as a character string if format == "hexstring".

Author(s)

Henrik Bengtsson

See Also

getName(). For more information see Object.

Examples

  obj <- Object()
  getInternalAddress(obj, format="numeric")    # 179742632
  getInternalAddress(obj, format="hexstring")  # "0x000000000ab6a7a8"

Gets all subclasses that are currently loaded

Description

Gets all subclasses that are currently loaded.

Usage

## S3 method for class 'Class'
getKnownSubclasses(this, sort=TRUE, ...)

Arguments

Value

Returns a vector of character strings.

Author(s)

Henrik Bengtsson

See Also

*getSuperclasses(). For more information see Class.

Examples

  ## Not run: 
  # Due to a bug in R CMD check (R v1.7.1) the MicroarrayData$read() call
  # below will call getKnownSubclasses(), which will generate
  #   "Error in exists(objectName, mode = "function") :
  #	   [2003-07-07 23:32:41] Exception: F used instead of FALSE"
  # Note that the example still work, just not in R CMD check

  print(getKnownSubclasses(Exception))
  
## End(Not run)
  ## Not run: 
  returns
  [1] "Exception" "try-error" "Object"
  
## End(Not run)

Gets the known subclasses

Description

Gets the known subclasses.

Usage

## S3 method for class 'classRepresentation'
getKnownSubclasses(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

Gets the License of this package

Description

Gets the License of this package as specified by the DESCRIPTION file.

Usage

## S3 method for class 'Package'
getLicense(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getLicense(pkg))

Gets the Maintainer of this package

Description

Gets the Maintainer of this package as specified by the DESCRIPTION file.

Usage

## S3 method for class 'Package'
getMaintainer(this, as=c("character", "person"), include=c("given", "family"), ...)

Arguments

Value

Returns a character string or a person object.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getMaintainer(pkg))

Gets the message of the Exception

Description

Gets the message of the Exception.

Usage

## S3 method for class 'Exception'
getMessage(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Exception.

Examples

## Not run: For a complete example see help(Exception).

Gets the message of the exception

Description

Gets the message of the exception and adds a message that clarifies that the error is likely due to an internal error and not due to the user. It also gives information how to contact the maintainer or author of the suspicious package. This information is retrieved from the DESCRIPTION file of the package. To help the package developer, information about the current version of R, the current version of the package etc are also returned so the user can easily cut'n'paste that information into a bug report.

Usage

## S3 method for class 'InternalErrorException'
getMessage(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see InternalErrorException.

Returns the method names of class and its super classes

Description

Returns the method names of class and its super classes as a list.

Usage

## S3 method for class 'Class'
getMethods(this, private=FALSE, deprecated=TRUE, unique=TRUE, ...)

Arguments

Value

Returns a named list of named character strings.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

  names <- getMethods(Exception)
  print(names)

Gets the name of the class

Description

Gets the name of the class.

Usage

## S3 method for class 'Class'
getName(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

  print(getName(Object))   # "Object"
  print(getName(Class))    # "Class"

Gets the name of this package

Description

Gets the name of this package.

Usage

## S3 method for class 'Package'
getName(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Gets the name of an environment

Description

Gets the name of an environment, e.g. "R_GlobalEnv" or "0x01ddd060".

Usage

## S3 method for class 'environment'
getName(env, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

environmentName().

Examples

  name <- getName(globalenv())
  print(name)
  stopifnot(identical(name, "R_GlobalEnv"))

  getName(new.env())

Gets the package to which the class belongs

Description

Gets the package to which the class belongs.

Usage

## S3 method for class 'Class'
getPackage(this, ...)

Arguments

Value

Returns a Package.

Author(s)

Henrik Bengtsson

See Also

Package. class(). setConstructorS3(). For more information see Class.

Examples

  print(getPackage(Object))

Gets the suspicious package likely to contain an error

Description

Gets the suspicious package likely to contain an error.

Usage

## S3 method for class 'InternalErrorException'
getPackage(this, ...)

Arguments

Value

Returns a Package object.

Author(s)

Henrik Bengtsson

See Also

For more information see InternalErrorException.

Gets the library (system) path to this package

Description

Gets the library (system) path to this package.

Usage

## S3 method for class 'Package'
getPath(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Gets the search path position of the package

Description

Gets the search path position of the package.

Usage

## S3 method for class 'Package'
getPosition(this, ...)

Arguments

Value

An integer.

Author(s)

Henrik Bengtsson

See Also

*getEnvironment(). search(). For more information see Package.

Examples

  pkg <- Package("base")
  print(getPosition(pkg))

Gets the class declaration in Rd format

Description

Gets the class declaration in Rd format.

Usage

## S3 method for class 'Class'
getRdDeclaration(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Gets the class declaration in Rd format

Description

Gets the class declaration in Rd format.

Usage

## S3 method for class 'classRepresentation'
getRdDeclaration(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

Gets the class hierarchy in Rd format

Description

Gets the class hierarchy in Rd format.

Usage

## S3 method for class 'Class'
getRdHierarchy(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Gets the class hierarchy in Rd format

Description

Gets the class hierarchy in Rd format.

Usage

## S3 method for class 'classRepresentation'
getRdHierarchy(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

Gets the methods of a class in Rd format

Description

Gets the methods of a class in Rd format.

Usage

## S3 method for class 'Class'
getRdMethods(class, visibilities=c("private", "protected", "public"), ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Gets the methods in Rd format

Description

Gets the methods in Rd format.

Usage

## S3 method for class 'classRepresentation'
getRdMethods(class, visibility=c("public", "protected", "private"), trial=FALSE, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

Gets the source of the exception

Description

.

Usage

## S3 method for class 'RdocException'
getSource(x, ...)

Arguments

Value

Returns the source.

Author(s)

Henrik Bengtsson

See Also

For more information see RdocException.

Gets the stack trace saved when the exception was created

Description

.

Usage

## S3 method for class 'Exception'
getStackTrace(this, cleanup=getOption("R.oo::Exception/getStackTrace/args/cleanup",
  TRUE), ...)

Arguments

Value

Returns a list containing the stack trace.

Author(s)

Henrik Bengtsson

See Also

*printStackTrace(). dump.frames(). tryCatch(). For more information see Exception.

Examples

## Not run: For a complete example see help(Exception).

Gets the stack trace as a string

Description

.

Usage

## S3 method for class 'Exception'
getStackTraceString(this, ..., details=TRUE)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

*getStackTrace(). For more information see Exception.

Gets the static instance of this class

Description

Gets the static instance of this class.

Usage

## S3 method for class 'Class'
getStaticInstance(this, ...)

Arguments

Value

Returns a reference to an Object.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

  obj <- getStaticInstance(Object)

Gets the static instance of this objects class

Description

Gets the static instance of this objects class.

Usage

## S3 method for class 'Object'
getStaticInstance(this, ...)

Arguments

Value

Returns a reference to an Object.

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Examples

  ex <- Exception("Oops!")
  obj <- getStaticInstance(ex)

Gets the super classes of this class

Description

Gets the super classes of this class.

Usage

## S3 method for class 'Class'
getSuperclasses(this, ...)

Arguments

Value

Returns a vector of character strings.

Author(s)

Henrik Bengtsson

See Also

class(). *getKnownSubclasses(). For more information see Class.

Examples

  print(getSuperclasses(RccViolationException))
  ## Not run: 
  returns
  [1] "Exception" "try-error" "Object"
  
## End(Not run)

Gets the superclasses

Description

Gets the superclasses.

Usage

## S3 method for class 'classRepresentation'
getSuperclasses(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

Gets the Title of this package

Description

Gets the Title of this package as specified by the DESCRIPTION file.

Usage

## S3 method for class 'Package'
getTitle(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getTitle(pkg))

Gets the URL of this package

Description

Gets the URL of this package as specified by the DESCRIPTION file.

Usage

## S3 method for class 'Package'
getUrl(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  pkg <- Package("R.oo")
  print(getUrl(pkg))

Gets the version of this package

Description

Gets the version of this package.

Usage

## S3 method for class 'Package'
getVersion(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package. *isOlderThan().

Gets the time when the Exception was created

Description

Gets the time, as a POSIX object, when the Exception was created.

Usage

## S3 method for class 'Exception'
getWhen(this, ...)

Arguments

Value

Returns a POSIX time object.

Author(s)

Henrik Bengtsson

See Also

For more information see Exception.

Examples

## Not run: For a complete example see help(Exception).

Checks if a field exists or not

Description

Checks if a field exists or not.

Usage

## S3 method for class 'BasicObject'
hasField(this, field, ...)

Arguments

Value

Returns a logical vector indicating for each field if it exists or not.

Author(s)

Henrik Bengtsson

See Also

To get the fields of an Object, see *getFields(). For more information see BasicObject.

Checks if a field exists or not

Description

Checks if a field exists or not.

Usage

## S3 method for class 'Object'
hasField(this, field, ...)

Arguments

Value

Returns a logical vector indicating for each field if it exists or not.

Author(s)

Henrik Bengtsson

See Also

To get the fields of an Object, see *getFields(). For more extensive information about the fields in an Object see *ll(). For more information see Object.

Examples

  obj <- Object()
  obj$x <- 1:100
  obj$y <- 100:1
  hasField(obj, c("x", "a", "b", "y"))

  ## Not run: 
  gives:

  [1] TRUE FALSE FALSE TRUE
  
## End(Not run)

Gets an integer hashcoded for R objects

Description

Gets an integer hashcoded for R objects.

Usage

## Default S3 method:
hashCode(object, ...)

Arguments

Details

A character string is converted into a hashcode following Java conventions by s[1]*31^(n-1) + s[2]*31^(n-2) + ... + s[n] using integer arithmetic, where s[i] is the i:th character of the string, n is the length of the string. The hash value of the empty string is zero.

For all other types, as.integer() is called by default.

Value

Returns a vector of integer's.

Author(s)

Henrik Bengtsson

Gets a hash code for the object

Description

Gets a hash code for the object.

Usage

## S3 method for class 'BasicObject'
hashCode(this, ...)

Arguments

Value

Returns an integer.

Author(s)

Henrik Bengtsson

See Also

*equals() For more information see BasicObject.

Gets a hash code for the Object

Description

Gets a hash code for the Object. This makes it possible to put any Object in a hash table.

The hash code returned must:

1) be consistent, i.e. hashCode(obj) should return the same value on multiple invocations as long as nothing has changed.

2) tell same same thing as equals(), if equals(o1,o2) is TRUE, then hashCode(o1) == hashCode(o2) should also be TRUE.

Note that if equals(o1,o2) is FALSE, hashCode(o1) hashCode(o2) may be either equal or non-equal.

By default, the method returns the internal memory address where the Object is located.

Usage

## S3 method for class 'Object'
hashCode(this, ...)

Arguments

Value

Returns a double.

Author(s)

Henrik Bengtsson

See Also

*equals() For more information see Object.

Examples

  obj <- Object()
  hashCode(obj)          # 26979608

Converts a vector of integers into a vector of ASCII characters

Description

Converts a vector of ASCII integers to a equal length vector of ASCII characters. To make sure that all values in the input vector are in the range [0,255], the input vector is taken modulo 256.

Usage

## Default S3 method:
intToChar(i, ...)

Arguments

Value

Returns an ASCII character vector.

Author(s)

Henrik Bengtsson

See Also

utf8Conversion. charToInt()

Examples

  i <- charToInt(unlist(strsplit("Hello world!", split=NULL)))
  # Gives: 72 101 108 108 111  32 119 111 114 108 100  33
  ch <- intToChar(c(72,101,108,108,111,32,119,111,114,108,100,33))
  # Gives: "H" "e" "l" "l" "o" " " "w" "o" "r" "l" "d" "!"

Checks if a class is abstract or not

Description

Checks if a class is abstract or not. A class is abstract if it has abstract methods.

Usage

## S3 method for class 'Class'
isAbstract(this, ...)

Arguments

Value

Returns TRUE if the class is abstract, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

class(). setConstructorS3(). For more information see Class.

Examples

  if (isAbstract(RccViolationException))
    throw("The class RccViolationException should NOT be abstract.")

Checks if a class is currently being initiated initiated

Description

Checks if a class is currently being initiated initiated. When extending a class for the first time, which is typically done in a constructor, a static instance of the class is created by calling the constructor without parameters. This method provides a way to detect that second call inside the constructor.

Usage

## S3 method for class 'Class'
isBeingCreated(this, ...)

Arguments

Value

Returns TRUE if a static instance exists, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

For more information see Class.

Examples

setConstructorS3("Car", function(brand=NULL, nbrOfWheels=0) {
  if(!isBeingCreated(Car)) {
    if (is.null(brand))
      throw("A car must have a brand")
     
    if (nbrOfWheels <= 0)
      throw("A car must have one or more wheels: ", nbrOfWheels)
  }

  extend(Object(), "Car",
    .brand = brand,
    .nbrOfWheels = nbrOfWheels
  )
})

setMethodS3("as.character", "Car", function(this, ...) {
  cat(class(this)[1], ":", this$.brand, " with ",
                     this$.nbrOfWheels, " wheels.", sep="")
})

print(Car("Volvo", 4))
print(Car("BMW", 4))
print(Car("Tyrrell P34", 6))
print(Car("T-Rex", 3))

Checks if a class is deprecated or not

Description

Checks if a class is deprecated or not.

Usage

## S3 method for class 'Class'
isDeprecated(this, ...)

Arguments

Value

Returns TRUE if the class is deprecated, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

class(). setConstructorS3(). For more information see Class.

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

Description

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

Usage

## S3 method for class 'Package'
isLoaded(this, ...)

Arguments

Value

TRUE if the packages has been loaded, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

*load(). search(). For more information see Package.

Examples

  pkg <- Package("base")
  print(isLoaded(pkg))       # TRUE

Checks if the package is older than a given version

Description

Checks if the package is older than a given version.

Usage

## S3 method for class 'Package'
isOlderThan(this, version, ...)

Arguments

Value

Returns TRUE if the version of the package is less than the specified version.

Author(s)

Henrik Bengtsson

See Also

For more information see Package. *getVersion().

Checks if a class is defined private or not

Description

Checks if a class is defined private or not.

Usage

## S3 method for class 'Class'
isPrivate(this, ...)

Arguments

Value

Returns TRUE if the class is private, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

class(). setConstructorS3(). For more information see Class.

Examples

  if (isPrivate(RccViolationException))
    throw("The class RccViolationException should NOT be private.")

Checks if a class is defined protected or not

Description

Checks if a class is defined protected or not.

Usage

## S3 method for class 'Class'
isProtected(this, ...)

Arguments

Value

Returns TRUE if the class is protected, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

class(). setConstructorS3(). For more information see Class.

Examples

  if (isProtected(RccViolationException))
    throw("The class RccViolationException should NOT be protected.")

Checks if a class is defined public or not

Description

Checks if a class is defined public or not. A class is public if it is neither private nor protected.

Usage

## S3 method for class 'Class'
isPublic(this, ...)

Arguments

Value

Returns TRUE if the class is public, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

class(). setConstructorS3(). For more information see Class.

Examples

  if (!isPublic(RccViolationException))
    throw("The class RccViolationException should be public.")

Checks if the object is referable or not

Description

Checks if the object is referable or not.

Usage

## S3 method for class 'BasicObject'
isReferable(this, ...)

Arguments

Value

Returns a logical value, which by default is TRUE for all BasicObject's.

Author(s)

Henrik Bengtsson

See Also

For more information see BasicObject.

Checks if the object is referable or not

Description

Checks if the object is referable or not.

Usage

## S3 method for class 'Object'
isReferable(this, ...)

Arguments

Value

Returns a logical value, which by default is TRUE for all Object's.

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Checks if a class is static or not

Description

Checks if a class is static or not. A class is static if it has static methods.

Usage

## S3 method for class 'Class'
isStatic(this, ...)

Arguments

Value

Returns TRUE if the class is static, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

setConstructorS3(). For more information see Class.

Examples

  if (!isStatic(RccViolationException))
    throw("RccViolationException should be static because Exception is.")

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

Description

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

Usage

## Default S3 method:
ll(pattern=".*", ..., private=FALSE, properties=getOption("R.oo::ll/properties",
  c("data.class", "dimension", "objectSize")), sortBy=NULL, decreasing=FALSE,
  envir=parent.frame())

Arguments

Value

Returns a data.frame containing information about all the members.

Default properties returned

It is possible to set the default value of argument properties by setting option "R.oo::ll/properties", e.g. options("R.oo::ll/properties"=c("data.class", "dimension")). If this option is not set when the package is loaded, it is set to c("data.class", "dimension", "objectSize").

Author(s)

Henrik Bengtsson

See Also

ls.str and ll.Object().

Examples

  ## Not run: 
   To list all objects in .GlobalEnv:
   > ll()
   		     member data.class dimension objectSize
   1                *tmp*     Person         1         428
   2  as.character.Person   function      NULL        1208
   3              country  character         1          44
   4        equals.Person   function      NULL        2324
   5             filename  character         1          84
   6               getAge   function      NULL         372
   7        getAge.Person   function      NULL         612
   8       getName.Person   function      NULL         628
   9      hashCode.Person   function      NULL        1196
   10        last.warning       list         1         192
   11                 obj     Person         1         428
   12              Person      Class      NULL        2292
   13              setAge   function      NULL         372
   14       setAge.Person   function      NULL        2088
   15             setName   function      NULL         372
   16      setName.Person   function      NULL         760
   17   staticCode.Person   function      NULL        2372

   To list all functions in the methods package:
   ll(mode="function", envir="methods")

   To list all numeric and character object in the base package:
   ll(mode=c("numeric", "character"), envir="base")

   To list all objects in the base package greater than 40kb:
   subset(ll(envir="base"), objectSize > 40000)
  
## End(Not run)

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

Description

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

Usage

## S3 method for class 'Object'
ll(this, ...)

Arguments

Value

Returns a data.frame containing information about all the members.

Author(s)

Henrik Bengtsson

See Also

ll.default(). For more information see Object.

Examples

  obj <- Object()
  obj$x <- 1:100
  obj$y <- 100:1
  ll(obj)

  ## Not run: 
  gives:

    member data.class dimension objectSize
  1      x    numeric       100        424
  2      y    numeric       100        424
  
## End(Not run)

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

Description

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

If the package is not loaded, it will be loaded, the members will be retrieved and then the package will be unloaded again.

Usage

## S3 method for class 'Package'
ll(this, envir=pos.to.env(getPosition(this)), ...)

Arguments

Details

Note the difference from the default definition of ll() as inherited from the Object class. Here ll() has been redefined to list the members of the package, i.e. the members in the environment on search path that belongs to the package, whereas the original usage was to list the members of the Object. However, since the internal members of Package object is not of interest we decided on this definition instead.

Value

Returns a data.frame.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  ## Not run: ll(R.oo)

Loads a package

Description

Loads a package. This is an alternative way to use library() to load a package.

Usage

## S3 method for class 'Package'
load(this, ...)

Arguments

Value

TRUE if the packages is loaded, otherwise FALSE.

Author(s)

Henrik Bengtsson

See Also

*unload(). *isLoaded(). search(). For more information see Package.

Examples

  pkg <- Package("base")
  print(load(pkg))

Creates a new instance of the same class as this object

Description

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

Usage

## S3 method for class 'BasicObject'
newInstance(this, ...)

Arguments

Value

Returns a reference to an instance of BasicObject or a subclass thereof.

Author(s)

Henrik Bengtsson

See Also

newInstance.Object(). newInstance.Class(). For more information see BasicObject.

Creates a new instance of this class

Description

Creates a new instance of this class. Important: It should always be possible to create a new Object by calling the constructor without arguments. This method is simply calling the constructor method of the class.

Usage

## S3 method for class 'Class'
newInstance(this, ...)

Arguments

Value

Returns a reference to an Object.

Author(s)

Henrik Bengtsson

See Also

newInstance.Object(). newInstance.BasicObject(). For more information see Class.

Examples

  obj <- newInstance(Object, NA)

  # equivalent to

  obj <- Object(NA)

Creates a new instance of the same class as this object

Description

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

Usage

## S3 method for class 'Object'
newInstance(this, ...)

Arguments

Value

Returns a reference to an instance of Object or a subclass thereof.

Author(s)

Henrik Bengtsson

See Also

newInstance.Class(). newInstance.BasicObject(). For more information see Object.

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

Description

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

Usage

## S3 method for class 'Object'
novirtual(this, ...)

Arguments

Value

Returns an Object.

Author(s)

Henrik Bengtsson

See Also

For more information see Object.

Gets the size of the object in bytes

Description

Gets the size of the object in bytes. This method is just a wrapper for object.size.

Usage

## Default S3 method:
objectSize(...)

Arguments

Value

Returns an integer.

Author(s)

Henrik Bengtsson

See Also

Internally object.size.

Gets the size of the BasicObject in bytes

Description

Gets the size of the BasicObject in bytes by summing the sizes of all its members. For this reason, the size of memory the BasicObject actually allocates might vary slightly.

Usage

## S3 method for class 'BasicObject'
objectSize(this, ...)

Arguments

Value

Returns an integer specifying the size of the object in number of bytes.

Author(s)

Henrik Bengtsson

See Also

object.size. For more information see BasicObject.

Gets the size of the Object in bytes

Description

Gets the size of the Object in bytes by summing the sizes of all its members. For this reason, the size of memory the Object actually allocates might vary slightly.

Usage

## S3 method for class 'Object'
objectSize(this, ...)

Arguments

Value

Returns an integer specifying the size of the object in number of bytes.

Author(s)

Henrik Bengtsson

See Also

To clear fields that are declared cached, see *clearCache(). object.size. For more information see Object.

Examples

  obj <- Object()
  obj$x <- 1:100
  obj$y <- 100:1
  objectSize(obj)   # 856

Gets the size of an environment in bytes

Description

Gets the size of an environment in bytes.

Usage

## S3 method for class 'environment'
objectSize(envir, ...)

Arguments

Value

Returns an integer.

Author(s)

Henrik Bengtsson

See Also

Internally object.size is used.

Prints a BasicObject

Description

For all objects of class BasicObject, this method will print the value of as.character() of the object. Note that this function is not called if the argument is not an object of class BasicObject.

Usage

## S3 method for class 'BasicObject'
print(x, ...)

Arguments

Author(s)

Henrik Bengtsson

See Also

print.default() For more information see BasicObject.

Prints detailed information about the class and its fields and methods

Description

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

Usage

## S3 method for class 'Class'
print(x, ...)

Arguments

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

*getDetails() For more information see Class.

Examples

  print(Object)

Prints the Exception

Description

. By default the as.character() representation plus the stack trace is printed.

Usage

## S3 method for class 'Exception'
print(x, ...)

Arguments

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

*as.character(). *getStackTrace(). *printStackTrace(). For more information see Exception.

Examples

## Not run: For a complete example see help(Exception).

Prints an Interface

Description

For all objects of class Interface, this method will print the value of as.character() of the object.

Usage

## S3 method for class 'Interface'
print(x, ...)

Arguments

Author(s)

Henrik Bengtsson

See Also

For more information see Interface.

Prints an Object

Description

For all objects of class Object, this method will print the value of as.character() of the object. Note that this function is not called if the argument is not an object of class Object.

Usage

## S3 method for class 'Object'
print(x, ...)

Author(s)

Henrik Bengtsson

See Also

print.default() For more information see Object.

Examples

## Not run: For a complete example see help(Object).

Prints the stack trace saved when the exception was created

Description

.

Usage

## S3 method for class 'Exception'
printStackTrace(this, ...)

Arguments

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

*getStackTrace(). tryCatch(). For more information see Exception.

Examples

## Not run: For a complete example see help(Exception).

Saves an Object to a file or a connection

Description

Saves an Object to a file or a connection.

Usage

## S3 method for class 'Object'
save(this, file=NULL, path=NULL, compress=TRUE, ..., safe=TRUE)

Arguments

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

*load() and save(), load(). For more information see Object.

Examples

## Not run: For a complete example see help(Object).

Defines a class in S3/UseMethod style

Description

Defines a class in R.oo/S3 style. What this function currently does is simply creating a constructor function for the class.

Usage

## Default S3 method:
setConstructorS3(name, definition, private=FALSE, protected=FALSE, export=TRUE,
  static=FALSE, abstract=FALSE, trial=FALSE, deprecated=FALSE, envir=parent.frame(),
  enforceRCC=TRUE, ...)

Arguments