plotLive: Plot array live times

View source: R/plot.R

plotLiveR Documentation

Plot array live times

Description

Plot array live times

Usage

plotLive(
  input,
  arrays,
  show.stations = FALSE,
  array.size = 2,
  station.size = 1,
  show.caps = TRUE,
  cap.prop = 2,
  title = "",
  xlab = "",
  ylab = "",
  col
)

Arguments

input

An actel results object, or a preload object

arrays

Optional: A subset of arrays to be plotted

show.stations

Logical: Should the live times of each station be shown under the array bars?

array.size

The size of the array bars (defaults to 2)

station.size

The size of the station bars (defaults to 1)

show.caps

Logical: Should cap lines be shown at the end of each live period?

cap.prop

The relative size of the caps, as compared to the respective bars (defaults to 2).

title

An optional title for the plot.

xlab, ylab

Optional axis names for the plot.

col

An optional colour scheme for the array bars. If left empty, default colours will be added. Note: Station bars are 40% lighter than the array bars.

Value

A ggplot object.

Examples

# Using the example results that come with actel
plotLive(example.results)

# Because plotLive returns a ggplot object, you can store
# it and edit it manually, e.g.:
library(ggplot2)
p <- plotLive(example.results)
p <- p + xlab("changed the x axis label a posteriori")
p

# You can also save the plot using ggsave!


actel documentation built on Oct. 19, 2023, 9:08 a.m.