pipeline_settings_get_set: Get or change pipeline input parameter settings

In raveio: File-System Toolbox for RAVE Project

Get or change pipeline input parameter settings

Description

Get or change pipeline input parameter settings

Usage

pipeline_settings_set(
  ...,
  pipeline_path = Sys.getenv("RAVE_PIPELINE", "."),
  pipeline_settings_path = file.path(pipeline_path, "settings.yaml")
)

pipeline_settings_get(
  key,
  default = NULL,
  constraint = NULL,
  pipeline_path = Sys.getenv("RAVE_PIPELINE", "."),
  pipeline_settings_path = file.path(pipeline_path, "settings.yaml")
)

Arguments

pipeline_path	the root directory of the pipeline
pipeline_settings_path	the settings file of the pipeline, must be a 'yaml' file; default is 'settings.yaml' in the current pipeline
key, ...	the character key(s) to get or set
default	the default value is key is missing
constraint	the constraint of the resulting value; if not NULL, then result must be within the constraint values, otherwise the first element of constraint will be returned. This is useful to make sure the results stay within given options

Value

pipeline_settings_set returns a list of all the settings. pipeline_settings_get returns the value of given key.

raveio documentation built on July 26, 2023, 5:29 p.m.