envvar (version 0.1.2)

envvar_get_list: Environment variables containing lists

Description

envvar_get_list() gets lists from environment variables. At the moment, only unnamed lists are supported.

envvar_get_csv() and envvar_get_psv() are an easy way to use envvar_get_list() with comma or pipe separators.

Usage

envvar_get_list(
  x,
  pattern = ":",
  default = NULL,
  validate = NULL,
  warn_default = TRUE,
  ...
)
envvar_get_csv(x, default = NA, validate = NULL, warn_default = TRUE)
envvar_get_psv(x, default = NA, validate = NULL, warn_default = TRUE)

Value

A list

Arguments

x

String containing an environment variable name

pattern

String specifying the pattern used to separate elements in the list.

default

Optional default value if the environment variable is not set

validate

Optional function that checks a value for validity

warn_default

Show a warning if the default value is used (default: TRUE)

...

Additional arguments passed to strsplit

Examples

# Get the value of `$PATH`, creating a list with elements for each directory
envvar_get_list("PATH")

# Parse an list separated by `|`
envvar_set("ROOMMATES" = "nandor|laszlo|nadja|guillermo|colin")
envvar_get_psv("ROOMMATES")