ggspectra (version 0.3.1)

plot.response_spct: Plot methods for response spectra.

Description

These methods return a ggplot object with an annotated plot of a response_spct object or of the spectra contained in a response_mspct object.

Usage

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

Arguments

x

a response_spct object or a response_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 string indicating type of radiation units to use for plotting: "photon" or its synomin "quantum", or "energy".

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.

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, or NULL for plotting the spectrum as is.

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.

ylim

numeric y axis limits,

na.rm

logical.

Value

a ggplot object.

See Also

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

Examples

# NOT RUN {
library(photobiology)
plot(photodiode.spct)
plot(photodiode.spct, unit.out = "photon")


# }