Get the root path for an environment

Retrieve the root (base) path for the given environment.

Usage

get_root(env = NULL, sys_env_vars = NULL)

Arguments

env

A character string specifying the environment for which to get the path. This should be one of 'main', 'ref' or 'test'.

sys_env_vars

A named character vector of the required system environment variables where their names are the package environments that they relate to. Note that the package environments, e.g. 'main' and 'ref', provide runtime information for using the package and should not be confused with the system environment (which specifies user-specific variables).

Value

A character string: the root path for the given environment.

See also

get_req_sys_env_vars()

Examples

if (FALSE) { # \dontrun{
get_root()
get_root("main")
get_root("ref")
} # }