These methods return a ggplot object with an annotated plot of a calibration_spct object or of the spectra contained in a calibration_mspct object.
# S3 method for calibration_spct
autoplot(
object,
...,
w.band = getOption("photobiology.plot.bands", default = list(UVC(), UVB(), UVA(),
PhR())),
range = NULL,
unit.out = "ignored",
pc.out = FALSE,
label.qty = "mean",
span = NULL,
wls.target = "HM",
annotations = NULL,
geom = "line",
time.format = "",
tz = "UTC",
norm = NULL,
text.size = 2.5,
idfactor = NULL,
facets = FALSE,
ylim = c(NA, NA),
object.label = deparse(substitute(object)),
na.rm = TRUE
)# S3 method for calibration_mspct
autoplot(
object,
...,
range = NULL,
unit.out = "ignored",
norm = getOption("ggspectra.normalize", default = "skip"),
pc.out = FALSE,
plot.data = "as.is",
idfactor = TRUE,
facets = FALSE,
object.label = deparse(substitute(object)),
na.rm = TRUE
)
a ggplot
object.
a calibration_spct object or a calibration_mspct object.
in the case of collections of spectra, additional arguments passed to the plot methods for individual spectra, otherwise currently ignored.
a single waveband object or a list of waveband objects.
an R object on which range() returns a vector of length 2, with min annd max wavelengths (nm).
character IGNORED.
logical, if TRUE use percents instead of fraction of one.
character string giving the type of summary quantity to use for labels, one of "mean", "total", "contribution", and "relative".
a peak is defined as an element in a sequence which is greater than all other elements within a window of width span centered at that element.
numeric vector indicating the spectral quantity values for
which wavelengths are to be searched and interpolated if need. The
character
strings "half.maximum" and "half.range" are also accepted
as arguments. A list with numeric
and/or character
values is
also accepted.
a character vector ("summaries" is ignored). For details please see sections Plot Annotations and Title Annotations.
character The name of a ggplot geometry, currently only
"area"
, "spct"
and "line"
. The default NULL
selects between them based on stacked
.
character Format as accepted by
strptime
.
character Time zone to use for title and/or subtitle.
numeric normalization wavelength (nm) or character string "max" for normalization at the wavelength of highest peak.
numeric size of text in the plot decorations.
character Name of an index column in data holding a
factor
with each spectrum in a long-form multispectrum object
corresponding to a distinct spectrum. If idfactor=NULL
the name of
the factor is retrieved from metadata or if no metadata found, the default
"spct.idx" is tried. If idfactor=NA
no aesthetic is mapped to the
spectra and the user needs to use 'ggplot2' functions to manually map an
aesthetic or use facets for the spectra.
logical or integer Indicating if facets are to be created for
the levels of idfactor
when spct
contain multiple spectra in
long form.
numeric y axis limits,
character The name of the object being plotted.
logical.
character Data to plot. Default is "as.is" plotting one line per spectrum. When passing "mean", "median", "sum", "prod", var", "sd", "se" as argument all the spectra must contain data at the same wavelength values.
The recognized annotation names are: "summaries"
, "peaks"
,
"peak.labels"
, "valleys"
, "valley.labels"
,
"wls"
, "wls.labels"
, "colour.guide"
,
"color.guide"
, "boxes"
, "segments"
, "labels"
.
In addition, "+"
is interpreted as a request to add to the already
present default annotations, "-"
as request to remove annotations
and "="
or missing"+"
and "-"
as a request to reset
annotations to those requested. If used, "+"
, "-"
or
"="
must be the first member of a character vector, and followed by
one or more of the names given above. To simultaneously add and remove
annotations one can pass a list
containing character
vectors
each assembled as described. The vectors are applied in the order they
appear in the list. To disable all annotations pass ""
or
c("=", "")
as argument. Adding a variation of an annotation already
present, replaces the existing one automatically: e.g., adding
"peak.labels"
replaces"peaks"
if present.
metadata retrieved from object object
is
paased to ggplot2::ggtitle()
as arguments for title
,
subtitle
and caption
. The specification for the title is
passed as argument to annotations
, and consists in the keyword
title
with optional modifiers selecting the kind of metatdata to
use, separated by colons. Up to three keywords separated by colons are
accepted, and correspond to title, subtitle and caption. The recognized
keywords are: "objt"
, "class"
, "what"
, "when"
,
"where"
, "how"
, "inst.name"
, "inst.sn"
,
"comment"
and "none"
are recognized as modifiers to
"title"
; "none"
is a placeholder. Default is
"title:objt"
or no title depending on the context.
normalize
,
calibration_spct
,
waveband
,
photobiologyWavebands-package
and
autoplot
Other autoplot methods:
autoplot.cps_spct()
,
autoplot.filter_spct()
,
autoplot.object_spct()
,
autoplot.raw_spct()
,
autoplot.reflector_spct()
,
autoplot.response_spct()
,
autoplot.source_spct()
,
autoplot.waveband()
,
set_annotations_default()