spaMM (version 2.0.0)

options: spaMM options settings

Description

Allow the user to set and examine a variety of options which affect operations of the spaMM package.

Usage

spaMM.options(…)
spaMM.getOption(x)

Arguments

x

a character string holding an option name.

…

A named value or a list of named values. The following values, with their defaults, are used in spaMM:

ff_threshold:

Minimal number of matrix elements for some matrices to be stored on disk (using the ff package) rather than in memory

COMP_maxn:

Number of terms for truncation of infinite sums that are evaluated in the fitting of COMPoisson models.

MESSAGES.FULL.STACK=TRUE:

Whether to give information on the stack of calls in some warning messages.

QRmethod:

A character string, to control whether dense matrix or sparse matrix methods are used in intensive matrix computations, overcoming the defaults choices made by spaMM in this respect. Possible values are "dense" and "sparse".

matrix_method:

A character string, to control the factorization of dense model matrices. Default value is "def_sXaug_EigenDense_QR_scaled". "def_sXaug_EigenDense_QRP_scaled" is sometimes useful (see arabidopsis). The source code should be consulted for further information.

Matrix_method:

A character string, to control the factorization of sparse model matrices. Default value is "def_sXaug_Matrix_QRP_scaled". The source code should be consulted for further information.

LevenbergM=FALSE:

Boolean. Whether to use a Levenberg-Marquardt algorithm (see Details) by default in most computations. But it is advised to use control.HLfit=list(LevenbergM=...) to control this on a case-by-case basis.

USEEIGEN=TRUE:

Whether to use the Eigen C++ library for some matrix computations.. The source code should be consulted for further information.

wRegularization=FALSE:

Whether to to warn about the use of regularization in some operations on nearly singular matrices.

maxLambda=1e10:

The maximum value of lambda: higher fitted lambda values in HLfit are reduced to this.

example_maxtime=0.8:

Used in the documentation to control whether the longer examples should be run. The approximate running time of given examples on one author's laptop is compared to this value.

and possibly other undocumented values for development purposes.

Value

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

For spaMM.options(), a list of all set options sorted by category. For spaMM.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).

Details

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

spaMM.options() provides an interface for changing maximal values of parameters of the Mat<U+00E9>rn correlation function. However, it is not recommended to change these values unless a spaMM message specifically suggests so. Errors may occur if too low values are chosen as these may conflit with default initial values for the parameters.

The Levenberg-Marquardt algorithm implementation uses the variant described by Nocedal & Wright (1999, p. 266).

References

Jorge Nocedal and Stephen J. Wright (1999) Numerical Optimization. Springer-Verlag, New York.

Examples

  spaMM.options()
  spaMM.getOption("example_maxtime")
  ## Not run: ------------------------------------
#   spaMM.options(maxLambda=1e06)
#   
## ---------------------------------------------