plot.source_spct {ggspectra}R Documentation

Plot method for light-source spectra.

Description

This function returns a ggplot object with an annotated plot of a source_spct object.

Usage

## S3 method for class 'source_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"),
  label.qty = NULL, span = NULL, annotations = NULL, time.format = "",
  tz = "UTC", text.size = 2.5, na.rm = TRUE)

Arguments

x

a source_spct object

...

other arguments passed along, such as label.qty

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"

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.

text.size

numeric size of text in the plot decorations.

na.rm

logical.

Value

a ggplot object.

Note

Note that scales are expanded so as to make space for the annotations. The object returned is a ggplot objects, and can be further manipulated.

See Also

Other plot functions: plot.calibration_spct, plot.cps_spct, plot.filter_spct, plot.object_spct, plot.raw_spct, plot.reflector_spct, plot.response_spct, plot.waveband

Examples

library(photobiology)
plot(sun.spct)
plot(sun.spct, unit.out = "photon")


[Package ggspectra version 0.2.3 Index]