TimeProfileDataMapping: TimeProfileDataMapping

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

TimeProfileDataMapping

Description

R6 class defining the configuration of a ggplot object for time profile plot

Super classes

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

Public fields

y2Axis

Name of y2Axis variable to map

Methods

Public methods

• TimeProfileDataMapping$new()

• TimeProfileDataMapping$checkMapData()

• TimeProfileDataMapping$requireDualAxis()

• TimeProfileDataMapping$getLeftAxis()

• TimeProfileDataMapping$getRightAxis()

• TimeProfileDataMapping$clone()

---

Method new()

Create a new TimeProfileDataMapping object

Usage

TimeProfileDataMapping$new(
  x = NULL,
  y = NULL,
  ymin = NULL,
  ymax = NULL,
  group = NULL,
  y2Axis = NULL,
  color = NULL,
  fill = NULL,
  linetype = NULL,
  data = NULL
)

Arguments

x

Name of x variable to map

y

Name of y variable to map

ymin

Name of ymin variable to map

ymax

Name of ymax variable to map

group

R6 class Grouping object or its input

y2Axis

Name of y2Axis variable to map

color

R6 class Grouping object or its input

fill

R6 class Grouping object or its input

linetype

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

TimeProfileDataMapping$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 requireDualAxis()

Assess if data require a dual axis plot

Usage

TimeProfileDataMapping$requireDualAxis(data)

Arguments

data

data.frame to check

Returns

A logical

---

Method getLeftAxis()

Render NA values for all right axis data

Usage

TimeProfileDataMapping$getLeftAxis(data)

Arguments

data

A data.frame

Returns

A data.frame to be plotted in left axis

---

Method getRightAxis()

Render NA values for all left axis data

Usage

TimeProfileDataMapping$getRightAxis(data)

Arguments

data

A data.frame

Returns

A data.frame to be plotted in right axis

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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

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