"Save plots of collective events"

Save plots of collective events

savePlotColl2D(
  objTS,
  objColl = NULL,
  plotbin = FALSE,
  datanno = NULL,
  outdir = ".",
  filecore = "",
  xlim = c(0, 1024),
  ylim = c(0, 1024),
  plotwh = c(3, 3),
  revy = FALSE,
  stretchf = TRUE,
  ptszmain = 2,
  ptszbin = 1,
  ptszanno = 2,
  ggtheme = NULL,
  imtype = c("png", "pdf"),
  colpal = "RdYlBu"
)

# S3 method for arcosTS
savePlotColl2D(
  objTS,
  objColl = NULL,
  plotbin = FALSE,
  datanno = NULL,
  outdir = ".",
  filecore = "",
  xlim = c(0, 1024),
  ylim = c(0, 1024),
  plotwh = c(3, 3),
  revy = TRUE,
  stretchf = TRUE,
  ptszmain = 2,
  ptszbin = 1,
  ptszanno = 2,
  ggtheme = NULL,
  imtype = c("png", "pdf"),
  colpal = "RdYlBu"
)

Arguments

objTS

an arcosTS object with time series.

objColl

an arcosTS object with collective events, defult NULL.

plotbin

a boolean, whether dots with binarised measurement should be plotted; default FALSE.

datanno

a data.table with T/X/Y annotations overlaid on the plot, default NULL.

outdir

a string with the dierctory to save the folder with frames; default ".".

filecore

a string with a prefix for output image files, default ".".

xlim

a vector with limits for the x-axis, default c(0, 1024).

ylim

a vector with limits for the y-axis, default c(0, 1024).

plotwh

a vector with width and height of the output image in inches, default c(3,3).

revy

logical whether to reverse the y-axis, default TRUE.

stretchf

logical whether to stretch the output sequence to include frames without objects, default TRUE.

ptszmain

numeric, size of main points in the plot, default 1.

ptszbin

numeric, size of points that indicate binarised measurement, default 0.1.

ptszanno

numeric, size of points that indicate annotated data, default 2.

ggtheme

a ggtheme object with additional style definitions; default NULL.

imtype

definition of the output image type, either "png" or "pdf".

colpal

colour palette for the main data, default 'RdYlBu'.

Details

Wrapper for the savePlotCollEvents2D function.

Examples

cat("no examples")
#> no examples