optionr: Management of customized (and nested) project/package options

In rappster/optionr: Management of customized (and nested) project/package options

Description

The package provides an extendable interface to conveniently create customized project/package options. Options can be specified and retrieved based on path-like names/identifiers (e.g. output/type/pdf = TRUE will be translated into the following nested environment structure: output$type$pdf with the value being TRUE).

Also, it allows to specify reactive options, i.e. options that are dynamically linked to other options and thus automatically stay synced.

Core convenience functions

• initializeOptionContainer:

  Initialize an option container that serves as a central point of reference for setting and retrieving project options and similar information.

• setPackageOption (getPackageOption):

  Set (retrieve) actual package options (from) a specific environment inside an option container.

• setMetaValue (getMetaValue):

  Set (retrieve) meta information (from) a specific environment inside an option container.

• setRegistryValue (getRegistryValue):

  Set (retrieve) registry information (from) a specific environment inside an option container.

• Removal functions:

  Remove components from option container.

  rmProjectOption, rmMetaValue, rmRegistryValue

Underlying core functions

• setAnywhereOption (getAnywhereOption):

  Set (retrieve) options (from) anywhere inside an option container. This function is called by most of the convenience functions listed above.

• Initialization functions:

  Actual component initialization can be controlled by definining methods for any of the following functions:

  initializeOptionContainer, initializeProjectOptions, initializeMeta, initializeRegistry

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/optionr

rappster/optionr documentation built on May 26, 2019, 11:23 p.m.