PKRatioDataMapping: PKRatioDataMapping

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

PKRatioDataMapping

Description

R6 class for mapping x, y, GroupMapping and pkRatio lines variables to data

Super classes

tlf::XYDataMapping -> tlf::XYGDataMapping -> PKRatioDataMapping

Public fields

lines

list of ratio limits to plot as horizontal lines

ymin

mapping of upper value of error bars around scatter points

ymax

mapping of lower value of error bars around scatter points

Methods

Public methods

• PKRatioDataMapping$new()

• PKRatioDataMapping$checkMapData()

• PKRatioDataMapping$clone()

---

Method new()

Create a new PKRatioDataMapping object

Usage

PKRatioDataMapping$new(
  x = NULL,
  y = NULL,
  ymin = NULL,
  ymax = NULL,
  lines = DefaultDataMappingValues$pkRatio,
  ...
)

Arguments

x

Name of x variable to map

y

Name of y variable to map

ymin

mapping of upper value of error bars around scatter points

ymax

mapping of lower value of error bars around scatter points

lines

List of ratio limits to display as horizontal lines

...

parameters inherited from XYGDataMapping

Returns

A new PKRatioDataMapping object

---

Method checkMapData()

Check that data variables include map variables

Usage

PKRatioDataMapping$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

PKRatioDataMapping$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

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

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