config (version 0.2)

get: Read configuration values

Description

Read from the currently active configuration, retreiving either a single named value or all values as a list.

Usage

get(value = NULL, config = Sys.getenv("R_CONFIG_ACTIVE", "default"), file = "config.yml", use_parent = TRUE)

Arguments

value

Name of value (NULL to read all values)

config

Name of configuration to read from. Defaults to the value of the R_CONFIG_NAME environment variable ("default" if the variable does not exist).

file

Configuration file to read from (defaults to "config.yml"). If the file isn't found at the location specified then parent directories are searched for a file of the same name.

use_parent

TRUE to scan parent directories for configuration files if the specified config file isn't found.

Value

The requested configuration value (or all values as a list of NULL is passed for value).

Details

For additional details see the package website at https://github.com/rstudio/config.