subjectProfileReportFormat: Get list with format specification for subject profile...

In patientProfilesVis: Visualization of Patient Profiles

Get list with format specification for subject profile report.

Description

This format is used to set default for the created subject profile report: line height, margin, report in landscape or portrait format, aspect ratio and width for the y-label.

Usage

subjectProfileReportFormat(
  heightLineIn = 0.2,
  margin = 0.75,
  landscape = FALSE,
  aspectRatio = 0.5,
  yLabelWidth = 30
)

Arguments

heightLineIn	Numeric of length 1 with height of a line in inches, 0.2 by default.
margin	Numeric of length 1, with margin in inches.
landscape	Logical, if TRUE the created report is in landscape format. FALSE by default, the report is created in portrait format.
aspectRatio	Numeric of length 1 (0.75 by default) with ratio between size of image in inches (derived from specified margin, landscape and heightLineIn) and real size for exported image.
yLabelWidth	Integer of length 1 with approximate maximum number of characters in the y-label of the plot, 30 by default. If the label of the y-axis is longer than this number of character, it will be splitted between words in separated lines.

Value

List with parameters to set format of the subject profile report. If not specified, default are used.

Author(s)

Laure Cougnaud

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