opts: Options for the justifier package

In Matherion/justifier: Human and Machine-Readable Justifications and Justified Decisions Based on 'YAML'

Description

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

Usage

opts

Format

An object of class list of length 4.

Details

If you use justifier to programmatically document your decisions in an R file, there is one option that you common use: workspace_id and workspace_option_name

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

The following arguments can be passed:

...

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

option

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

default

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

The following options can be set:

The name of the column with the effect size values.

The name of the column with the effect size variance.

The name of the column with the missing values.

Examples

### Get the default 'silent' setting
justifier::opts$get('silent');

### Set to FALSE
justifier::opts$set(silent = FALSE);

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

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

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

Matherion/justifier documentation built on Dec. 31, 2020, 3:13 p.m.