subjectProfileExport: Create report

View source: R/report_createSubjectProfileReport.R

subjectProfileExportR Documentation

Create report

Description

Create report

Usage

subjectProfileExport(
  listPlotsSubject,
  outputFile = "subjectProfile.pdf",
  index = NULL,
  formatReport = subjectProfileReportFormat(),
  shiny = FALSE,
  verbose = FALSE,
  nCores = NULL,
  exportFigures = FALSE
)

Arguments

listPlotsSubject

List of plots for each subject

outputFile

string, path to the output report

index

Index, output from defineIndex

formatReport

list with parameters used to specify the format of the report, e.g. output of the subjectProfileReportFormat function

shiny

logical, set to TRUE (FALSE by default) if the report is generated from a Shiny application. Messages during report creation will be included in the Shiny interface, and it will be mentioned at the end of the report. In this case, the shiny package should be available.

verbose

logical, if TRUE print messages during execution

nCores

Integer containing the number of cores used for the computation (1 by default). If more than 1, computation is parallelized, in this case the package parallel is required.

exportFigures

Logical, if TRUE (FALSE by default) the subject profile figures are also exported in pdf format in a 'figures' folder.
Figures are named as [subjectID]-[page].pdf

Value

No returned value, the plots are exported to outputDir

Author(s)

Laure Cougnaud


patientProfilesVis documentation built on Nov. 18, 2022, 5:12 p.m.