Options for the zirconia package

The zirconia::opts object contains three functions to set, get, and reset options used by the zirconia package. Use zirconia::opts$set to set options, zirconia::opts$get to get options, or zirconia::opts$reset to reset specific or all options to their default values.

Usage

opts

Format

An object of class list of length 4.

Details

It is normally not necessary to get or set zirconia options.

The following arguments can be passed:

...: For zirconia::opts$set, the dots can be used to specify the options to set, in the format option = value, for example, utteranceMarker = "\n". For zirconia::opts$reset, a list of options to be reset can be passed.
option: For zirconia::opts$set, the name of the option to set.
default: For zirconia::opts$get, the default value to return if the option has not been manually specified.

The following options can be set:

silent: Whether to be silent or chatty.

Examples

### Get the default 'silent' setting
zirconia::opts$get(silent);
#> [1] TRUE

### Set it to FALSE (to be chatty)
zirconia::opts$set(silent = FALSE);

### Check that it worked
zirconia::opts$get(silent);
#> [1] FALSE

### Reset this option to its default value
zirconia::opts$reset(silent);

### Check that the reset worked, too
zirconia::opts$get(silent);
#> [1] TRUE