splitChapter {clinDataReview} | R Documentation |
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 |
mdFile |
(optional) Path to the Markdown file containing the chapter.
If not specified, the Markdown file corresponding to the specified
|
indexPath |
String with path to the index file,
by default 'index.Rmd' in |
intermediateDir |
String with intermediate directory ('interim'
by default), where
markdown files and rds file specifying Js libraries (with |
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
parameterspecification 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