Learn R Programming

ggspectra (version 0.3.13)

cal_plot: Create a complete ggplot for an irradiation calibration spectrum.

Description

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

Usage

cal_plot(
  spct,
  w.band,
  range,
  pc.out,
  label.qty,
  span,
  wls.target,
  annotations,
  geom,
  norm,
  text.size,
  idfactor,
  facets,
  ylim,
  na.rm,
  ...
)

Value

a ggplot object.

Arguments

spct

a calibration_spct object

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)

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.

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

geom

character The name of a ggplot geometry, currently only "area", "spct" and "line". The default NULL selects between them based on stacked.

norm

numeric Normalization wavelength (nm) or character string "max", or "min" for normalization at the corresponding wavelength, "update" to update the normalization after modifying units of expression, quantity or range but respecting the previously used criterion, or "skip" to force return of object unchanged. Always skipped for plot.qty == "all", which is the default.

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.

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.

...

currently ignored.