addScatter: addScatter

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

addScatter

Description

Add a scatter plot layer to a ggplot object

Usage

addScatter(
  data = NULL,
  metaData = NULL,
  x = NULL,
  y = NULL,
  caption = NULL,
  color = NULL,
  shape = NULL,
  size = NULL,
  linetype = 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.
y	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
shape	Optional character values defining the shapes/symbols of the plot layer. See enum Shapes to get names of shapes.
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.
dataMapping	A XYGDataMapping object mapping x, y 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

See Also

Other atom plots: addErrorbar(), addLine(), addRibbon(), initializePlot()

Examples

# Add scatter using x and y
addScatter(x = c(1, 2, 1, 2, 3), y = c(5, 0, 2, 3, 4))

# Add scatter using a data.frame
time <- seq(0, 30, 0.1)
scatterData <- data.frame(x = time, y = cos(time))

addScatter(
  data = scatterData,
  dataMapping = XYGDataMapping$new(x = "x", y = "y")
)

# Or for simple cases a smart mapping will get directly x and y from data
addScatter(data = scatterData)

# Add a scatter with caption
addScatter(data = scatterData, caption = "My scatter plot")

# Add a scatter with specific properties
addScatter(
  data = scatterData,
  color = "blue", shape = "diamond", size = 2, caption = "My data"
)

# Add a scatter with specific properties
p <- addScatter(
  data = scatterData,
  color = "blue", shape = "diamond", size = 2, caption = "My data"
)
addScatter(
  x = c(0, 1), y = c(1, 0),
  color = "red", shape = "circle", size = 3,
  plotObject = p
)

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