Options for the bookmark package

The bookmark::opts object contains three functions to set, get, and reset options used by the bookmark package. Use bookmark::opts$set to set options, bookmark::opts$get to get options, or bookmark::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 bookmark options; they represent default values that can in principle be maintained.

The following arguments can be passed:

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

The following options can be set:

quiet: TRUE or FALSE to indicate whether to suppress messages or not.

Examples

### Get whether to suppress messages by default
bookmark::opts$get(quiet);
#> Error in bookmark::opts$get(quiet): Option 'quiet' is not a valid (i.e. existing) option for the {bookmark} package!

### Set it to not suppress messages any more
bookmark::opts$set(quiet = FALSE);
#> Error in bookmark::opts$set(quiet = FALSE): Option(s) 'quiet' is/are not a valid (i.e. existing) option for the {bookmark} package!

### Check that it worked
bookmark::opts$get(quiet);
#> Error in bookmark::opts$get(quiet): Option 'quiet' is not a valid (i.e. existing) option for the {bookmark} package!

### Reset this option to its default value
bookmark::opts$reset(quiet);
#> Error in bookmark::opts$reset(quiet): Option(s) 'quiet'' is/are not a valid (i.e. existing) option for the {bookmark} package!

### Check that the reset worked, too
bookmark::opts$get(quiet);
#> Error in bookmark::opts$get(quiet): Option 'quiet' is not a valid (i.e. existing) option for the {bookmark} package!