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 one option. The option is stored in the R global list and is:

colorSpec.stoponerror

For details on what it does see logging.

It can be set using the built-in function base::options(). When R starts up, an option can be set using a call to base::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 little helper 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

• an error 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( stop=TRUE )             # no problems, no warning
cs.options( stop='TRUE' )           # warns that value has the wrong type
cs.options( stop=FALSE, "DEBUG" )   # warns that the 2nd argument has no name

colorSpec documentation built on April 4, 2025, 1:59 a.m.