XYGDataMapping: XYGDataMapping

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

XYGDataMapping

Description

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

Super class

tlf::XYDataMapping -> XYGDataMapping

Public fields

groupMapping

R6 class GroupMapping object

Methods

Public methods

• XYGDataMapping$new()

• XYGDataMapping$checkMapData()

• XYGDataMapping$clone()

---

Method new()

Create a new XYGDataMapping object

Usage

XYGDataMapping$new(
  x = NULL,
  y = 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

y

Name of y 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 XYGDataMapping object

---

Method checkMapData()

Check that data variables include map variables

Usage

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

XYGDataMapping$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, TornadoDataMapping, XYDataMapping

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