userOptions: Set and Get User "Session" Options that influence "regr0"s...

In regr0: Building regression models

Description

The user can set (and get) "Session" options which influence the behavior regr0 functions, notably stamp().

Usage

userOptions  (x=NULL, default=NULL, list=NULL, ...)
getUserOption(x, default = NULL)
UserOptions
UserDefault

Arguments

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'.

Value

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).

Note

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.

Author(s)

Werner A. Stahel

See Also

stamp; R's own predefined options().

Examples

## 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)

regr0 documentation built on May 2, 2019, 4:52 p.m.