read_params

Set stage dir and load parameters from params.yaml

Usage

read_params(stage_path = NULL, return_list = FALSE)

Arguments

stage_path

relative path to stage directory from project root, when NULL, already set stage path will be taken from the config_environment

return_list

returns a list if TRUE, by default it return `dsoParams` class which is a list with secure access

Value

parameters as list of list as `dsoParams` or conventional list when `return_list` is set.

Details

It is required to provide the path of the current stage relative to the project root to ensure that the correct config is loaded, no matter of the current working directory (as long as the working directory is any subdirectory of the project root). The function recompiles params.in.yaml to params.yaml on-the-fly to ensure that up-to-date params are always loaded.