options: blackbox options settings

Description Usage Arguments Details Value Examples

Description

Allow the user to examine a variety of “options” (most of which are not true user options) which affect operations of the blackbox package.

Usage

1
2
3

Arguments

x

a character string holding an option name.

...

A named value or a list of named values. Most are not to be manipulated by users and are undocumented. Exceptions are:

ParameterNames

See Details

FONKgNames

See Details

fittedNames

See Details

gridStepsNbr

Number of steps of the grid of value for each parameter in profile plots.

graphicPars

Graphic parameters used for most plots.

verbosity=0:

Controls display of information about generalized cross-validation. 0 suppresses (most) messages. 1 displays information about estimates and progress of the procedure. Higher values display more information from the optimizer and possibly additional information.

Details

Invoking blackbox.options() with no arguments returns a list with the current values of the options. Invoking blackbox.getOption(<option name>) returns the value of the option rather than a list.

blackbox.options() provides an interface for changing many undocumented options.

The package is designed to infer likelihood surfaces by smoothing estimated likelihood points in a model with some canonical parameters (ParameterNames). A transformed parameter space may be considered for smoothing, wherein some parameters are variable (fittedNames) and others may be constant. The transformed parameter space including constant parameters has names FONKgNames (FON for Fitted Or Not).

Value

For blackbox.getOption, the current value set for option x, or NULL if the option is unset.

For blackbox.options(), a list of all set options sorted by category. For blackbox.options(name), a list of length one containing the set value, or NULL if it is unset. For uses setting one or more options, a list with the previous values of the options changed (returned invisibly).

Examples

1
2
3
4
5
6
  blackbox.getOption("verbosity")
  ## Not run: 
  blackbox.options(verbosity=1)
  blackbox.options()
  
## End(Not run)


Search within the blackbox package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.