TornadoPlotConfiguration: TornadoPlotConfiguration

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

TornadoPlotConfiguration

Description

R6 class defining the configuration of a ggplot object for tornado plots

Super class

tlf::PlotConfiguration -> TornadoPlotConfiguration

Public fields

bar

logical setting if tornado is uses a bar plot instead of regular points

colorPalette

color palette property from ggplot2

dodge

space between the bars/points

defaultYScale

Default yAxis scale value when creating a TornadoPlotConfiguration object

Methods

Public methods

• TornadoPlotConfiguration$new()

• TornadoPlotConfiguration$clone()

---

Method new()

Create a new TornadoPlotConfiguration object

Usage

TornadoPlotConfiguration$new(bar = TRUE, colorPalette = NULL, dodge = 0.5, ...)

Arguments

bar

logical setting if tornado is uses a bar plot instead of regular points

colorPalette

color palette property from ggplot2

dodge

space between the bars/points

...

parameters inherited from PlotConfiguration

Returns

A new TornadoPlotConfiguration object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

TornadoPlotConfiguration$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, TimeProfilePlotConfiguration, XAxisConfiguration, YAxisConfiguration

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