behaviorchange (version 0.5.5)

opts: Options for the behaviorchange package

Description

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

The following arguments can be passed:

...

For behaviorchange::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 behaviorchange::opts$reset, a list of options to be reset can be passed.

option

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

default

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

To see the full list of options and their default values, use behaviorchange::opts$default(). Some examples are:

aabbcc

A color theme for abcd().

complecs_*

The worksheet and columns names for complecs().

silent

Whether to be chatty or silent.

Examples

### Get the default utteranceMarker
behaviorchange::opts$get(complecs_entitySheet);

### Set it to a custom version, so that every line starts with a pipe
behaviorchange::opts$set(complecs_entitySheet = "sheet_with_entities");

### Check that it worked
behaviorchange::opts$get(complecs_entitySheet);

### Reset this option to its default value
behaviorchange::opts$reset(complecs_entitySheet);

### Check that the reset worked, too
behaviorchange::opts$get(complecs_entitySheet);