getParamsFromConfig: Get parameters from a config file

In clinDataReview: Clinical Data Review Tool

Get parameters from a config file

Description

Please note that the information from this config file and the general config file: config.yml are considered.
In case parameters are defined both in the general and specific config files, the parameter from the general config file is ignored.

Usage

getParamsFromConfig(
  configFile,
  configDir = file.path(inputDir, "config"),
  inputDir = "."
)

Arguments

configFile	String with filename of the config file of interest in YAML format.
configDir	String with directory with config files, by default a 'config' folder in inputDir. It should contain a general 'config.yml' file and dedicated 'config-[X].yml' for each chapter. The order of each chapter is specified in the 'config' slot in the general general 'config.yml'.
inputDir	String with input directory, working directory by default.

Value

List with parameters from the specified configFile and the general config file: config.yml.
There are two specific handlers:

• parameters tagged with '[param] !r [value]' are evaluated in R, and their evaluated value is returned

• parameters tagged with '[param] !r-lazy [value]' are imported as character, and need to be further process with forceParams inside the report.

Parameters with YAML type 'r-lazy' are imported as character, with this additional class.

Author(s)

Laure Cougnaud

See Also

forceParams

Other clinical data reporting: checkReportTitles(), forceParams(), getMdHeader(), gitbook_clinDataReview_report(), html_clinDataReview_report(), knitPrintClinDataReview(), postProcessReport(), render_clinDataReviewReport()

clinDataReview documentation built on April 12, 2025, 1:14 a.m.