r6x: Extensions to the R6 package

In rappster/r6x: Extensions to the R6 package

Description

Facilitates the creation of formal S4 equivalents for R6 classes and provides a base layer object for inheritance featuring basic methods such as '.getFieldNames()' and '.getMethodNames()' that seem to be required often.

Core functions/methods of this package

• withFormalClass:

  Defines an R6 class with the side effect of buffering the respective S3 class information that can later be used by formalizeClasses in order to register formal S4 equivalents.

• formalizeClassses:

  Takes the information produced by all calls to withFormalClass in order use it accordinly in calls to setOldClass in order to register formal S4 equivalents of all R6 classes that have been defined via withFormalClass.

The core classes of this package

• Object:

  Base layer class for inheritance providing numerous methods that seem to be often required. Selected examples:

  • .getComponentNames: List the names of all components (regardless if field or method)

  • .getComponentClasses: List the classes of all components (regardless if field or method)

  • .getFieldNames: List all field names

  • .getMethodNames: List all method names

  • .getField: Internal getter method with validation options (e.g. name)

  • .setField: Internal setter method with validation options (e.g. name, type)

  • .message: Method for signaling messages in a standardized format

  • .warning: Method for signaling warnings in a standardized format

  • .error: Method for signaling errors in a standardized format

Author(s)

Janko Thyson [e-mail]

References

http://github.com/rappster/r6x

rappster/r6x documentation built on May 26, 2019, 11:55 p.m.