TimeProfilePlotConfiguration: TimeProfilePlotConfiguration

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

TimeProfilePlotConfiguration

Description

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

Super class

tlf::PlotConfiguration -> TimeProfilePlotConfiguration

Public fields

lloqDirection

Whether to draw LLOQ lines for x (vertical), y (horizontal) or x and y (both).

Active bindings

y2Axis

YAxisConfiguration object defining properties of y2-axis

Methods

Public methods

• TimeProfilePlotConfiguration$new()

• TimeProfilePlotConfiguration$clone()

---

Method new()

Create a new TimeProfilePlotConfiguration object

Usage

TimeProfilePlotConfiguration$new(
  ...,
  y2label = NULL,
  y2Axis = NULL,
  y2Scale = NULL,
  y2ValuesLimits = NULL,
  y2AxisLimits = NULL,
  y2Limits = lifecycle::deprecated(),
  lloqDirection = "horizontal",
  data = NULL,
  metaData = NULL,
  dataMapping = NULL
)

Arguments

...

parameters inherited from PlotConfiguration

y2label

character or Label object defining plot y2label

y2Axis

YAxisConfiguration object defining y-axis properties

y2Scale

name of y2-axis scale. Use enum Scaling to access predefined scales.

y2ValuesLimits

numeric vector of length 2 defining y values limits

y2AxisLimits

numeric vector of length 2 defining y axis limits

y2Limits

. Replaced by y2AxisLimits argument.

lloqDirection

Whether to draw LLOQ lines for x (vertical), y (horizontal) or x and y (both).

data

data.frame used by .smartMapping

metaData

list of information on data

dataMapping

R6 class or subclass TimeProfileDataMapping

Returns

A new TimeProfilePlotConfiguration object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

TimeProfilePlotConfiguration$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other PlotConfiguration classes: AxisConfiguration, BackgroundConfiguration, BackgroundElement, BoxWhiskerPlotConfiguration, CumulativeTimeProfilePlotConfiguration, DDIRatioPlotConfiguration, ExportConfiguration, HistogramPlotConfiguration, LabelConfiguration, LegendConfiguration, LineElement, ObsVsPredPlotConfiguration, PKRatioPlotConfiguration, PieChartPlotConfiguration, PlotConfiguration, PlotGridConfiguration, QQPlotConfiguration, ResVsPredPlotConfiguration, ResVsTimePlotConfiguration, TornadoPlotConfiguration, XAxisConfiguration, YAxisConfiguration

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