plotSensors: Plot sensor data for a single tag

View source: R/plot.R

plotSensorsR Documentation

Plot sensor data for a single tag

Description

The output of plotSensors is a ggplot object, which means you can then use it in combination with other ggplot functions, or even together with other packages such as patchwork.

Usage

plotSensors(
  input,
  tag,
  sensor,
  title = tag,
  xlab,
  ylab,
  pcol,
  psize = 1,
  lsize = 0.5,
  colour.by = c("array", "section"),
  array.alias,
  lcol = "grey40",
  verbose = TRUE
)

Arguments

input

The results of an actel analysis (either explore, migration or residency).

tag

The transmitter to be plotted.

sensor

The sensors to be plotted. If left empty, all available sensors are plotted

title

An optional title for the plot. If left empty, a default title will be added.

xlab, ylab

Optional axis names for the plot. If left empty, default axis names will be added.

pcol

The colour for the points. If unset, a default palette is used.

psize

The size of the points. Defaults to 1.

lsize

The width of the line. Defaults to 0.5 (same as standard ggplots)

colour.by

One of "arrays" or "sections", defines how the points should be coloured.

array.alias

A named vector of format c("old_array_name" = "new_array_name") to replace default array names with user defined ones. Only relevant if colour.by = "arrays".

lcol

The colour for the line. Defaults to grey.

verbose

Logical: Should warning messages be printed, if necessary?

Value

A ggplot object.

Examples

# Using the example results that come with actel
plotSensors(example.results, 'R64K-4451')

# Because plotSensors returns a ggplot object, you can store
# it and edit it manually, e.g.:
library(ggplot2)
p <- plotSensors(example.results, 'R64K-4451')
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.