default_config: Create a path pointing to a configuration file

In 2DegreesInvesting/r2dii.utils: General Utility Tools

Create a path pointing to a configuration file

Description

• default_config() returns a the path to the default configuration file that comes with this package.

• get_config() returns a the path to the default configuration file unless you set a new path via options(r2dii_config = "a/path/to/your/config.yml").

• example_config(<path>) returns a path to a configuration file for examples and tests; example_config() returns a character string with available configuration files for examples.

Usage

default_config()

example_config(path = NULL)

get_config()

Arguments

path	Character string giving the name of an available file. See available files with example_config().

Value

Character string.

See Also

FINANCIAL.TIMESTAMP

Other functions to deal with configuration files: create_config(), edit_config(), show_config()

Examples

default_config()

example_config()
example_config("config-toy.yml")
getOption("r2dii_config")
get_config()

restore <- options(r2dii_config = "path/to/your/config.yml")

getOption("r2dii_config")
get_config()

options(restore)
getOption("r2dii_config")
get_config()

2DegreesInvesting/r2dii.utils documentation built on March 31, 2022, 11:20 p.m.