checkChapterParallel: Check if a chapter is run internally in parallel or not.

In clinDataReview: Clinical Data Review Tool

Check if a chapter is run internally in parallel or not.

Description

This is identified via the 'parallel' parameter from the config file. If this parameter is not available in the config file (or the parameters are imported with an error), the chapter is considered to not be run in parallel.

Usage

checkChapterParallel(
  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

Logical, if TRUE, the chapter is run in parallel (FALSE if not available).

clinDataReview documentation built on March 7, 2023, 5:13 p.m.