get_config_env: get_config_env helper function

View source: R/get_config_env.R

get_config_envR Documentation

get_config_env helper function

Description

Internal function to read settings for a certain system from the environment. IMPORTANT: If yout want to get any result with your input as prefix, use 'ignore_presets = TRUE'! See param-definition for more details. This function will look at uppercase system_names at default.

Usage

get_config_env(
  system_name,
  logfile_dir = tempdir(),
  headless = TRUE,
  ignore_presets = FALSE,
  uppercase_system = TRUE
)

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'). This function also works if there are multiple instances like 'I2B2_1_DBNAME' and 'I2B2_2_DBNAME'. Then the result will contain nested lists for each occurence.

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').

ignore_presets

(boolean, default = FALSE) Only return something if all elements from the presets are found? These are currently 'host', 'port', 'user', 'password', 'sid', 'path'. If you have another suffix after ‘system_name' in your config file, you won’t see it here. To see everything with prefix 'system_name' simply set 'ignore_presets = TRUE'.

uppercase_system

(boolean) Default: True. Otherwise: case-sensitive.

Value

If successful it returns the config, null otherwise.

Examples


get_config_env(
  system_name = "i2b2",
  logfile_dir = tempdir(),
  headless = FALSE
)


miracum/misc-dizutils documentation built on July 2, 2022, 11:21 p.m.