getPageVar: Get variable with page of the plot, used for automatic paging...

In patientProfilesVis: Visualization of Patient Profiles

Get variable with page of the plot, used for automatic paging of a plot

Description

Get variable with page of the plot, used for automatic paging of a plot

Usage

getPageVar(
  data,
  var,
  typeVar = c("y", "panel"),
  formatReport = subjectProfileReportFormat(),
  title = TRUE,
  xLab = TRUE,
  caption = TRUE,
  paging = TRUE,
  table = FALSE
)

Arguments

data	data.frame with data
var	string, variable of data with variable for the y-axis
typeVar	string, type of the variable, either: 'y': the variable is displayed in the x-axis or 'panel': the variable is displayed as separated facets. This is used to compute height for each line of the plot.
formatReport	list with parameters used to specify the format of the report, e.g. output of the subjectProfileReportFormat function
title	logical, has the plot a title?
xLab	logical, has the plot a label for the x-axis?
caption	logical, has the plot a caption?
paging	Logical, if TRUE (by default), automatic paging is enabled, so patient profiles module too big to fit in one page will span multiple pages. Please note that the size of the graphic window (or report page) may need to be re-sized in order that the plot fits. If FALSE, the entire plot is included in one single page.
table	Logical, if TRUE the paramValueVar variables are displayed as table (so are not concatenated).

Value

input data with additional column 'pagePlot' containing the page for the plot

Author(s)

Laure Cougnaud

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