options {spam}R Documentation

Options Settings

Description

Allow the user to set and examine a variety of options which affect the way in which R computes and displays sparse matrix results.

Usage

spam.options(...)

spam.getOption(x)

Arguments

... any options can be defined, using name = value or by passing a list of such tagged values. However, only the ones below are used in spam. Further, spam.options('name') == spam.options()['name'], see the example.
x a character string holding an option name.

Details

Invoking spam.options() with no arguments returns a list with the current values of the options. To access the value of a single option, one should use spam.getOption("eps"), e.g., rather than spam.options("eps") which is a list of length one.

Internally, the options are kept in the list .Spam.

Value

For spam.getOption, the current value set for option x, or NULL if the option is unset.
For spam.options(), a list of all set options sorted by category. For spam.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).

Options used in this-is-escaped-codenormal-bracket30bracket-normal

A short description with the default values follows.

eps=.Machine$double.eps:
values smaller than this are considered as zero. This is only used when creating spam objects.
drop=FALSE:
default parameter for drop when subsetting
printsize=100:
the max number of elements of a matrix which we display as regular matrix.
imagesize=10000:
the max number of elements of a matrix we display as regular matrix with image or display. Larger matrices are represented as dots only.
trivalues=FALSE:
a flag whether to return the structure (FALSE) or the values themselves (TRUE) when returning the upper and lower triangular part of a matrix.
cex=1200:
default dot size for image or display.
version
Version information from DESCRIPTION file
safemode=TRUE:
verify double and integer formats
bcksl=TRUE:
what type of back/forwardsolve?

Author(s)

spam.options is essentially identical to sm.options.

See Also

print, display, image, upper.tri, etc.

Examples

op <- spam.options(); utils::str(op)

smat <- diag.spam( 1:8)
smat
spam.options( printsize=49)
smat




[Package spam version 0.13-3 Index]