knitPrintClinDataReview: Include output from clinical data, or list of such outputs in...

View source: R/reporting-utility.R

knitPrintClinDataReviewR Documentation

Include output from clinical data, or list of such outputs in a Rmarkdown report, with an appropriate title.

Description

Include output from clinical data, or list of such outputs in a Rmarkdown report, with an appropriate title.

Usage

knitPrintClinDataReview(list, sep = ".", level = 1)

Arguments

list

Named list of clinical data plots, the names are used for the section header. If several section header should be created, either:

  • a list of level 1 named by the different group elements, separated by sep, e.g. list('group1.param1' = .., 'group1.param2' = ...). Such list is e.g. created with dlply.

  • a nested list, named with the different groups, e.g. created with lapply

sep

String with separator used to distinguish different levels in the labels of the list. e.g. '.' by default.

level

Integer with base level for section, 1 by default.

Value

No returned value, the plots are included in the report. If a element in the list are empty (NULL), these elements (and the associated sections) are not included in the report.

Author(s)

Laure Cougnaud

See Also

Other clinical data reporting: checkReportTitles(), forceParams(), getMdHeader(), getParamsFromConfig(), gitbook_clinDataReview_report(), html_clinDataReview_report(), postProcessReport(), render_clinDataReviewReport()


clinDataReview documentation built on June 22, 2024, 10:03 a.m.