ggspectra (version 0.3.1)

plot.calibration_spct: Plot methods for spectral irradiation calibrations.

Description

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.

Usage

# S3 method for calibration_spct
plot(x, ...,
  w.band = getOption("photobiology.plot.bands", default = list(UVC(),
  UVB(), UVA(), PAR())), range = NULL, unit.out = "counts",
  pc.out = FALSE, label.qty = "mean", span = NULL,
  annotations = NULL, time.format = "", tz = "UTC", norm = NULL,
  text.size = 2.5, idfactor = NULL, ylim = c(NA, NA), na.rm = TRUE)

# S3 method for calibration_mspct plot(x, ..., range = NULL)

Arguments

x

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.

w.band

a single waveband object or a list of waveband objects.

range

an R object on which range() returns a vector of length 2, with min annd max wavelengths (nm).

unit.out

character IGNORED.

pc.out

logical, if TRUE use percents instead of fraction of one.

label.qty

character string giving the type of summary quantity to use for labels, one of "mean", "total", "contribution", and "relative".

span

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.

annotations

a character vector ("summaries" is ignored).

time.format

character Format as accepted by strptime.

tz

character Time zone to use for title and/or subtitle.

norm

numeric normalization wavelength (nm) or character string "max" for normalization at the wavelength of highest peak.

text.size

numeric size of text in the plot decorations.

idfactor

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.

ylim

numeric y axis limits,

na.rm

logical.

Value

a ggplot object.

See Also

Other plot functions: autoplot.generic_spct, plot.cps_spct, plot.filter_spct, plot.object_spct, plot.raw_spct, plot.reflector_spct, plot.response_spct, plot.source_spct, plot.waveband