generic_plot: Create a complete ggplot for generic spectral data.

In ggspectra: Extensions to 'ggplot2' for Radiation Spectra

Create a complete ggplot for generic spectral data.

Description

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

Usage

generic_plot(
  spct,
  y.name,
  ymin.name,
  ymax.name,
  ylab,
  w.band,
  range,
  label.qty,
  span,
  wls.target,
  annotations,
  text.size,
  idfactor,
  facets,
  ylim,
  na.rm
)

Arguments

spct	a generic_spct object
y.name, ymin.name, ymax.name	character Names of the columns to be mapped to the y aesthetic.
ylab	character or expression The y-axis label.
w.band	list of waveband objects
range	an R object on which range() returns a vector of length 2, with min annd max wavelengths (nm)
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.
wls.target	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.
annotations	a character vector
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.
facets	logical or integer Indicating if facets are to be created for the levels of idfactor when spct contain multiple spectra in long form.
ylim	numeric y axis limits,
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 object, and can be further manipulated. When spct has more than one column with spectral data, each of these columns is normalized individually.

ggspectra documentation built on April 4, 2025, 2:19 a.m.