RangeDataMapping: RangeDataMapping

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

RangeDataMapping

Description

R6 class for mapping x, ymin and ymax variable to data

Super classes

tlf::XYDataMapping -> tlf::XYGDataMapping -> RangeDataMapping

Public fields

ymin

Name of ymin variable to map

ymax

Name of ymax variable to map

Methods

Public methods

• RangeDataMapping$new()

• RangeDataMapping$checkMapData()

• RangeDataMapping$clone()

---

Method new()

Create a new RangeDataMapping object

Usage

RangeDataMapping$new(
  x = NULL,
  ymin = NULL,
  ymax = NULL,
  groupMapping = NULL,
  color = NULL,
  fill = NULL,
  linetype = NULL,
  shape = NULL,
  size = NULL,
  group = NULL,
  data = NULL
)

Arguments

x

Name of x variable to map

ymin

Name of ymin variable to map

ymax

Name of ymax variable to map

groupMapping

R6 class GroupMapping object

color

R6 class Grouping object or its input

fill

R6 class Grouping object or its input

linetype

R6 class Grouping object or its input

shape

R6 class Grouping object or its input

size

R6 class Grouping object or its input

group

R6 class Grouping object or its input

data

data.frame to map used by .smartMapping

Returns

A new RangeDataMapping object

---

Method checkMapData()

Check that data variables include map variables

Usage

RangeDataMapping$checkMapData(data, metaData = NULL)

Arguments

data

data.frame to check

metaData

list containing information on data

Returns

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

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RangeDataMapping$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, ResVsPredDataMapping, ResVsTimeDataMapping, TimeProfileDataMapping, TornadoDataMapping, XYDataMapping, XYGDataMapping

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