clinDataReview-common-args-report {clinDataReview} | R Documentation |
Common parameters for the clinical data reporting function
Description
Common parameters for the clinical data reporting function
Arguments
indexPath |
String with path to the index file,
by default 'index.Rmd' in |
configDir |
String with directory with config files,
by default a 'config' folder in |
configFile |
String with filename of the config file of interest in YAML format. |
inputDir |
String with input directory, working directory by default. |
outputDir |
String with output directory, ('report' by default). |
intermediateDir |
String with intermediate directory ('interim'
by default), where
markdown files and rds file specifying Js libraries (with |
extraDirs |
Character vector with extra directories required by
the report, directory with external images.
By default, the directories: 'figures', 'tables' and mentioned in the
'patientProfilePath' parameter of the
general config file are included.
All these folders should be available in |
mdFile |
String with path of the Markdown file |
logFile |
(optional) String with path to a log file, where output (also error/messages/warnings) should be stored. If specified, the entire output is re-directed to this file. |
nCores |
Integer containing the number of cores used to render the report (1 by default). If more than 1, two steps of the report creation are run in parallel across chapters:
|
verbose |
Logical, if TRUE (FALSE by default) progress messages are printed during the report execution. |
Value
No return value, used for the documentation of the clinical data reporting functions of the package.