useroptions {regr} | R Documentation |
The user can set (and get) "Session" options which influence the
behavior regr0 functions, notably stamp()
.
useroptions (x=NULL, default=NULL, list=NULL, useroptions = NULL, assign = TRUE, ...) getUseroption(x, default = NULL) .useroptions useroptionsDefault
x |
option to query or set |
default |
default value |
list |
a list of options to be set |
... |
any Useroptions can be defined or modified, using 'name = value'. |
useroptions |
a list containing the actual user options.
The effective default is |
assign |
logical: should the result be assigned to
|
For 'getUseroption', the current value set for Useroption 'x', or 'NULL' if the option is not set.
For 'useroptions()', a list of all set Useroptions sorted by name. For 'useroptions(name)', a list of length one containing the set value, or 'NULL' if it is not set. For uses setting one or more options, a list with the previous values of the Useroptions that are changed (returned invisibly).
In contrast to the options
of R base,
the Useroptions
are stored on the .GlobalEnv
(if anyone is changed)
and will be recovered if the latter is stored and loaded again.
Werner A. Stahel
stamp
; R's own predefined options()
.
## see example(stamp) ## set options useroptions(project="Example A", step="regression analysis") useroptions(show.termeffects=FALSE) ## suppress dummy coefficients ## for factors when using print.regr useroptions("regr.contrasts") ## c("contr.wsum","contr.wpoly") useroptions(stamp=NULL) getUseroption("stamp", default=2)