options: Functions to set and retrieve colorSpec package options

In colorSpec: Color Calculations with Emphasis on Spectral Data

Functions to set and retrieve colorSpec package options

Description

colorSpec has a few options. The options are stored in the R global list and they are:

colorSpec.loglevel, colorSpec.logformat, and colorSpec.stoponerror

For details on what they do see logging.

They can be set using the built-in function options(). When R starts up, an option can be set using a call to options() in the file Rprofile.site. If colorSpec is later loaded, the value of the option will not be changed. If an option has not been assigned, then it is created with a default value.

The function cs.options() makes setting the options a little easier in a few ways:

• it automatically prepends the string 'colorSpec.'

• partial matching of the option name is enabled

• a warning is issued when the option value has the wrong type

Usage

cs.options( ... )

Arguments

...	named arguments are set; unnamed arguments are ignored with a warning. See Examples.

Value

returns a list with all the colorSpec options.

See Also

logging, options

Examples

cs.options( loglevel="DEBUG", stop=FALSE )  # 'stop' partially matches 'stoponerror'
cs.options( stop='TRUE' )                   # warns that value has the wrong type
cs.options( stop=FALSE, "DEBUG" )           # warns that the 2nd argument has no name
cs.options( loglevel="WARN" )               # back to default

colorSpec documentation built on May 29, 2024, 6 a.m.