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

addErrorbar

R Documentation

addErrorbar

Description

Add an errorbar layer to a ggplot object.

Usage

addErrorbar(
  data = NULL,
  metaData = NULL,
  x = NULL,
  ymin = NULL,
  ymax = NULL,
  caption = NULL,
  color = NULL,
  size = NULL,
  linetype = NULL,
  capSize = NULL,
  dataMapping = NULL,
  plotConfiguration = NULL,
  plotObject = NULL
)

Arguments

`data`	A data.frame to use for plot.
`metaData`	A named list of information about `data` such as the `dimension` and `unit` of its variables.
`x`	Numeric values to plot along the `x` axis. Only used instead of `data` if `data` is `NULL`.
`ymin`	Numeric values to plot along the `y` axis. Only used instead of `data` if `data` is `NULL`.
`ymax`	Numeric values to plot along the `y` axis. Only used instead of `data` if `data` is `NULL`.
`caption`	Optional character values defining the legend captions of the plot.
`color`	Optional character values defining the colors of the plot layer. See `grDevices::colors()` to get names of colors
`size`	Optional numeric values defining the size of the plot layer.
`linetype`	Optional character values defining the linetype of the plot layer. See enum `Linetypes` to get names of linetype.
`capSize`	Numeric extent of the error bars caps Caution the value corresponds to the ratio of the mean spacing between plotted error bars. For instance, an `extent` of `1` will fill the caps until the next error bar
`dataMapping`	A `RangeDataMapping` object mapping `x`, `ymin`, `ymax` and aesthetic groups to their variable names of `data`.
`plotConfiguration`	An optional `PlotConfiguration` object defining labels, grid, background and watermark.
`plotObject`	An optional `ggplot` object on which to add the plot layer

Value

A ggplot object

References

For examples, see: https://www.open-systems-pharmacology.org/TLF-Library/articles/atom-plots.html

Examples

# Add errorbar using x, ymin and ymax
addErrorbar(
  x = c(1, 2, 1, 2, 3),
  ymin = c(5, 0, 2, 3, 4),
  ymax = c(6, 2, 6, 2.5, 5)
)

# Add errorbar using a data.frame
time <- seq(0, 30, 0.5)
errorbarData <- data.frame(x = time, ymin = cos(time) - 1, ymax = cos(time) + 1)

addErrorbar(
  data = errorbarData,
  dataMapping = RangeDataMapping$new(x = "x", ymin = "ymin", ymax = "ymax")
)

# Or for simple cases a smart mapping will get directly x, ymin and ymax from data
addErrorbar(data = errorbarData)

# Add a errorbar with caption
addErrorbar(data = errorbarData, caption = "My errorbar plot")

# Add a errorbar with specific properties
addErrorbar(data = errorbarData, color = "blue", size = 0.5, caption = "My data")

# Add a errorbar with specific properties
p <- addErrorbar(
  data = errorbarData,
  color = "blue", size = 0.5, caption = "My data"
)
addScatter(
  x = time, y = cos(time),
  color = "red", size = 1, caption = "My data",
  plotObject = p
)

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