ObsVsPredDataMapping: ObsVsPredDataMapping

In Open-Systems-Pharmacology/TLF-Library: TLF Library

ObsVsPredDataMapping

Description

Class for mapping variables in observations vs predictions plot

Super classes

tlf::XYDataMapping -> tlf::XYGDataMapping -> ObsVsPredDataMapping

Public fields

lines

list of ratio limits to plot as horizontal lines

xmin

mapping of upper value of error bars around scatter points

xmax

mapping of lower value of error bars around scatter points

smoother

regression function name

lloq

mapping lloq lines

Methods

Public methods

• ObsVsPredDataMapping$new()

• ObsVsPredDataMapping$checkMapData()

• ObsVsPredDataMapping$clone()

---

Method new()

Create a new ObsVsPredDataMapping object

Usage

ObsVsPredDataMapping$new(
  x = NULL,
  y = NULL,
  xmin = NULL,
  xmax = NULL,
  lines = DefaultDataMappingValues$obsVsPred,
  smoother = NULL,
  lloq = NULL,
  ...
)

Arguments

x

Name of x variable to map

y

Name of y variable to map

xmin

mapping of upper value of error bars around scatter points

xmax

mapping of lower value of error bars around scatter points

lines

list of lines to plot

smoother

smoother function or parameter

lloq

mapping lloq lines To map a loess smoother to the plot, use smoother="loess"

...

parameters inherited from XYGDataMapping

Returns

A new ObsVsPredDataMapping object

---

Method checkMapData()

Check that data variables include map variables

Usage

ObsVsPredDataMapping$checkMapData(data, metaData = NULL)

Arguments

data

data.frame to check

metaData

list containing information on data

Returns

A data.frame with map and defaultAes variables. Dummy variable defaultAes is necessary to allow further modification of plots.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ObsVsPredDataMapping$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other DataMapping classes: BoxWhiskerDataMapping, CumulativeTimeProfileDataMapping, DDIRatioDataMapping, GroupMapping, Grouping, HistogramDataMapping, ObservedDataMapping, PKRatioDataMapping, PieChartDataMapping, QQDataMapping, RangeDataMapping, ResVsPredDataMapping, ResVsTimeDataMapping, TimeProfileDataMapping, TornadoDataMapping, XYDataMapping, XYGDataMapping

Open-Systems-Pharmacology/TLF-Library documentation built on Feb. 8, 2025, 11:22 a.m.