The ufs::opts
object contains three functions to set, get, and reset
options used by the ufs package. Use ufs::opts$set
to set options,
ufs::opts$get
to get options, or ufs::opts$reset
to reset specific or
all options to their default values.
opts
An object of class list
of length 5.
It is normally not necessary to get or set ufs
options.
The following arguments can be passed:
For ufs::opts$set
, the dots can be used to specify the options
to set, in the format option = value
, for example,
tableOutput = c("console", "viewer")
. For
ufs::opts$reset
, a list of options to be reset can be passed.
For ufs::opts$set
, the name of the option to set.
For ufs::opts$get
, the default value to return if the
option has not been manually specified.
The following options can be set:
Where to show some tables.
### Get the default columns in the variable view
ufs::opts$get("tableOutput");
#> [1] "console" "viewer"
### Set it to a custom version
ufs::opts$set(tableOutput = c("values", "level"));
### Check that it worked
ufs::opts$get("tableOutput");
#> [1] "values" "level"
### Reset this option to its default value
ufs::opts$reset("tableOutput");
### Check that the reset worked, too
ufs::opts$get("tableOutput");
#> [1] "console" "viewer"