TornadoDataMapping: TornadoDataMapping

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

TornadoDataMapping

Description

R6 class for mapping values, labels to data

Super classes

tlf::XYDataMapping -> tlf::XYGDataMapping -> TornadoDataMapping

Public fields

lines

numeric vector of limits to plot

sorted

logical indicating if values should be sorted

Methods

Public methods

• TornadoDataMapping$new()

• TornadoDataMapping$checkMapData()

• TornadoDataMapping$clone()

---

Method new()

Create a new TornadoDataMapping object

Usage

TornadoDataMapping$new(
  lines = DefaultDataMappingValues$tornado,
  sorted = NULL,
  x = NULL,
  y = NULL,
  ...
)

Arguments

lines

numeric vector of limits to plot

sorted

logical indicating if values should be sorted

x

Variable including the values of tornado plot

y

Variable including the labels of tornado plot

...

parameters inherited from XYGDataMapping

Returns

A new TornadoDataMapping object

---

Method checkMapData()

Check that data variables include map variables

Usage

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

TornadoDataMapping$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

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

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