opts: Options for the preregr package

In preregr: Specify (Pre)Registrations and Export Them Human- And Machine-Readably

Options for the preregr package

Description

The preregr::opts object contains three functions to set, get, and reset options used by the preregr package. Use preregr::opts$set to set options, preregr::opts$get to get options, or preregr::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 preregr options.

The following arguments can be passed:

...

For preregr::opts$set, the dots can be used to specify the options to set, in the format option = value, for example, utteranceMarker = "\n". For preregr::opts$reset, a list of options to be reset can be passed.

option

For preregr::opts$set, the name of the option to set.

default

For preregr::opts$get, the default value to return if the option has not been manually specified.

The following options can be set:

quridPrefix

The prefix for quasi-unique record identifiers (QURIDs).

Two

Second item

Examples

### Get the default "silence versus chattiness" setting
preregr::opts$get(silent);

### Set it to show all messages
preregr::opts$set(silent = FALSE);

### Check that it worked
preregr::opts$get(silent);

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

### Check that the reset worked, too
preregr::opts$get(silent);

preregr documentation built on May 31, 2023, 7:10 p.m.