clinDataReview-templates: Rmarkdown templates for clinical data

Description Details Value Parameter type Clinical data template for a visualization of count data : countsVisualizationTemplate Clinical data template to create a report division : divisionTemplate Clinical data template to create a listing : listingTemplate Clinical data template for the creation of patient profiles : patientProfilesTemplate Clinical data generic template for visualization : plotTemplate Clinical data template for visualization of summarized data : summaryPlotTemplate Clinical data template for a summary table of the data : summaryTableTemplate

Description

Template reports with standard visualizations/tables available in the package are described here.

Details

For each template, required parameters are indicated in bold.

Value

No return value, used for the documentation of the Rmarkdown template reports contained in the package.

Parameter type

Please note that the type mentioned below corresponds to the type in the config file (in YAML/JSON format).The mapping to R data type is as followed:

Clinical data template for a visualization of count data : countsVisualizationTemplate

This report compute counts of variable(s) of interest (with the inTextSummaryTable package) and visualize them with a treemap and/or sunburst.
The following parameters are available:

Clinical data template to create a report division : divisionTemplate

This report includes a division, i.e. extra chapter, section of subsection in the report.
The following parameters are available:

Clinical data template to create a listing : listingTemplate

This report displays a listing of the variables and data of interest, displayed in an interactive table. This table can contains comparison with a previous batch ('comparisonTable' parameters).
The following parameters are available:

Clinical data template for the creation of patient profiles : patientProfilesTemplate

This report creates the specified patient profiles (with the patientProfilesVis package) by subject, and export them to a specified directory.
The following parameters are available:

Clinical data generic template for visualization : plotTemplate

This report visualizes input data with a function of the clinical data review package. The data can be compared to the data of a previous batch, in the table associated to the plot ('comparisonTable' parameters).
The following parameters are available:

Clinical data template for visualization of summarized data : summaryPlotTemplate

This report summarizes the data of interest (with the inTextSummaryTable package) and visualize it with any clinical data review plot function.
The following parameters are available:

Clinical data template for a summary table of the data : summaryTableTemplate

This report summarizes the data of interest (with the inTextSummaryTable package). This table is displayed with an interactive table in the report, and exported to a docx file. This table can be compared to a summary table of a previous batch ('comparisonTable' parameters).
The following parameters are available:


clinDataReview documentation built on July 14, 2021, 5:08 p.m.