get_config_env: get_config_env helper function

Description Usage Arguments Value Examples

View source: R/get_config_env.R

Description

Internal function to read settings for a certain system from the environment

Usage

1
get_config_env(system_name, logfile_dir, headless)

Arguments

system_name

The name of the system (This is also the prefix used to get the environment variables with 'SYSTEM_KEY', e.g. 'I2B2_DBNAME')

logfile_dir

(Optional, String, default: "tempdir()") The absolute path to folder where the logfile will be stored.

headless

A boolean (default: FALSE). Indicating, if the function is run only in the console (headless = TRUE) or on a GUI frontend (headless = FALSE).

Value

If successful it returns the config, null otherwise.

Examples

1
2
3
4
5
get_config_env(
  system_name = "i2b2",
  logfile_dir = tempdir(),
  headless = FALSE
)

miracum/misc-dizutils documentation built on Nov. 21, 2020, 7:41 p.m.