plot.clusteraverages: plots cluster averages

View source: R/clusterTools.R

plot.clusteraveragesR Documentation

plots cluster averages

Description

plots average time series of clusters as calculated by clusterAverages, including the variations around the mean as polygons

Usage

## S3 method for class 'clusteraverages'
plot(
  x,
  cls.srt,
  cls.col,
  each = FALSE,
  ranges = TRUE,
  border = 0,
  xlab,
  time,
  ylab = "average",
  ylim = ifelse(each, "avg", "rng"),
  ylim.scale = 0.1,
  ...
)

Arguments

x

cluster time series average object as calculated by clusterAverages

cls.srt

optional sorting of clusters; clusters will be plotted in this order, i.e. the last in cls.srt is plotted last; can be used for selecting a subset of clusters

cls.col

optional coloring of clusters

each

logical value indicating whether to plot all cluster averages on one panel (FALSE) or each cluster on a separate panel (TRUE)

ranges

logical indicating whether to plot the ranges ‘high’ and ‘low’ in the cluster average object avg

border

line width of border line at data ranges

xlab

x-axis label

time

optional time-points of the x-axis

ylab

y-axis label

ylim

either conventional range of the y-axis, or a string specifying whether ylim should be calculated from the average (ylim="avg") or from the lower/upper ranges (ylim="rng")

ylim.scale

if ylim=="avg", the calculated ylim will be extended by this fraction of the total range on both sides

...

arguments to plot


raim/segmenTools documentation built on April 25, 2024, 10:14 a.m.