splitChapter: Split a chapter based on the 'split_by' parameter.

In clinDataReview: Clinical Data Review Tool

Split a chapter based on the 'split_by' parameter.

Description

Split a chapter based on the 'split_by' parameter.

Usage

splitChapter(
  configFile = NULL,
  configDir = "./config",
  mdFile = NULL,
  indexPath = "index.Rmd",
  intermediateDir = "./interim",
  outputDir = "./report",
  verbose = TRUE
)

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'.
mdFile	(optional) Path to the Markdown file containing the chapter. If not specified, the Markdown file corresponding to the specified configFile parameter is used.
indexPath	String with path to the index file, by default 'index.Rmd' in inputDir.
intermediateDir	String with intermediate directory ('interim' by default), where markdown files and rds file specifying Js libraries (with knit_meta) for each sub report are stored.
outputDir	String with output directory, ('report' by default).
verbose	Logical, if TRUE (FALSE by default) progress messages are printed during the report execution.

Value

No return value, the Markdown files are split as specified.

Extension to chapter-specific split

The bookdown 'split_by' parameter is extended, to support:

• chapter-specific split, specified in the configuration file of the specific chapter, via the split_by parameter

• specification as a number (if specified within a config file), e.g. '0' for no split, 1' for chapter, '2' for section, '3' for subsection, ...

• split at section level higher than 2 (until 7) (if specified within a config file)

Author(s)

Laure Cougnaud

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