setDefaultTimeProfileStatistics: setDefaultTimeProfileStatistics

In Open-Systems-Pharmacology/OSPSuite.ReportingEngine: R package to create reports for the Open Systems Pharmacology models

setDefaultTimeProfileStatistics

Description

Set default statistics used in population time profiles and residuals plots

Usage

setDefaultTimeProfileStatistics(
  statisticsType = NULL,
  y = NULL,
  ymin = NULL,
  ymax = NULL,
  yCaption = NULL,
  rangeCaption = NULL
)

Arguments

statisticsType	Name of statistics type as defined in enum StatisticsTypes
y	Function or function name for middle values statistics
ymin	Function or function name for min values statistics
ymax	Function or function name for max values statistics
yCaption	Legend caption for middle values statistics
rangeCaption	Legend caption for range values statistics

Examples

## Not run: 
# Set the default statistics as geometric mean
setDefaultTimeProfileStatistics(statisticsType = StatisticsTypes$`Geometric mean`)

# Set the default legend caption displayed for range
setDefaultTimeProfileStatistics(rangeCaption = "90% population range")

## End(Not run)

Open-Systems-Pharmacology/OSPSuite.ReportingEngine documentation built on April 13, 2025, 10:37 a.m.