Blockr Options — blockr_option • blockr.core

Retrieves options via base::getOption() or base::Sys.getenv(), in that order, and prefixes the option name passed as name with blockr. or blockr_ respectively. Additionally, the name is converted to lower case for getOption() and upper case for environment variables. In case no value is available for a given name, default is returned.

Usage

blockr_option(name, default)

Arguments

name: Option name
default: Default value

Value

The value set as option name or default if not set. In case of the option being available only as environment variable, the value will be a string and if available as base::options() entry it may be of any R type.

Examples

blockr_option("test-example", "default")
#> [1] "default"

options(`blockr.test-example` = "non-default")
blockr_option("test-example", "default")
#> [1] "non-default"

Sys.setenv(`BLOCKR_TEST-EXAMPLE` = "another value")
tryCatch(
  blockr_option("test-example", "default"),
  error = function(e) conditionMessage(e)
)
#> [1] "Conflicting options set for test-example: check environment variable `BLOCKR_TEST-EXAMPLE` and option `blockr.test-example`."
options(`blockr.test-example` = NULL)
blockr_option("test-example", "default")
#> [1] "another value"

Sys.unsetenv("BLOCKR_TEST-EXAMPLE")
blockr_option("test-example", "default")
#> [1] "default"