AxisConfiguration: AxisConfiguration

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

AxisConfiguration

Description

R6 class defining the configuration of axis

Active bindings

valuesLimits

numeric vector of length 2 defining limits of axis. A value of NULL is allowed and lead to default ggplot2 behaviour

axisLimits

numeric vector of length 2 defining limits of axis. A value of NULL is allowed and lead to default ggplot2 behaviour

scale

name of axis scale from Enum Scaling A value of NULL is allowed and will lead to a default linear scale

ticks

function or values defining where axis ticks are placed

minorTicks

function or values defining where axis minor ticks are placed

ticklabels

function or values defining the axis tick labels

font

Font object defining the font of the ticklabels

expand

logical defining if data is expanded until axis. If TRUE, data is expanded until axis If FALSE, some space between data and axis is kept

Methods

Public methods

• AxisConfiguration$new()

• AxisConfiguration$ggplotScale()

• AxisConfiguration$ggplotExpansion()

• AxisConfiguration$prettyTicks()

• AxisConfiguration$prettyMinorTicks()

• AxisConfiguration$prettyTickLabels()

• AxisConfiguration$clone()

---

Method new()

Create a new AxisConfiguration object

Usage

AxisConfiguration$new(
  valuesLimits = NULL,
  axisLimits = NULL,
  limits = lifecycle::deprecated(),
  scale = Scaling$lin,
  ticks = NULL,
  ticklabels = NULL,
  minorTicks = NULL,
  font = NULL,
  expand = FALSE
)

Arguments

valuesLimits

numeric vector of value limits (data outside these limits is removed)

axisLimits

numeric vector of axis limits (data outside these limits is kept but not plotted)

limits

. Replaced by axisLimits argument.

scale

character defining axis scale Use enum Scaling to access predefined scales.

ticks

numeric vector or function defining where to position axis ticks

ticklabels

character vector or function defining what to print on axis ticks

minorTicks

numeric vector or function defining where to position minor axis ticks

font

Font object defining the font of ticklabels

expand

logical defining if data is expanded until axis. If TRUE, data is expanded until axis If FALSE, some space between data and axis is kept

Returns

A new AxisConfiguration object

---

Method ggplotScale()

Get the ggplot2 actual trans name of scale

Usage

AxisConfiguration$ggplotScale()

Returns

A character included in ggplot2 available trans names

---

Method ggplotExpansion()

Get the ggplot2 actual function for expansion

Usage

AxisConfiguration$ggplotExpansion()

Returns

A ggplot2 function

---

Method prettyTicks()

Get tick values for pretty default log plots

Usage

AxisConfiguration$prettyTicks()

Returns

User defined tick values or tlf default ticks

---

Method prettyMinorTicks()

Get tick values for pretty default log plots

Usage

AxisConfiguration$prettyMinorTicks()

Returns

User defined tick values or tlf default ticks

---

Method prettyTickLabels()

Get tick labels for pretty default log plots

Usage

AxisConfiguration$prettyTickLabels()

Returns

User defined tick labels or tlf default ticklabels

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AxisConfiguration$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

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

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