Spectral irradiance axis labels

Generate axis labels for spectral irradiance in SI units, using SI scale factors. Output can be selected as character, expression (R default devices) or LaTeX (for tikz device).

Usage

s.e.irrad_label(
  unit.exponent = 0,
  format = getOption("photobiology.math", default = "R.expression"),
  label.text = axis_labels()[["s.e.irrad"]],
  scaled = FALSE,
  normalized = FALSE,
  axis.symbols = getOption("ggspectra.axis.symbols", default = TRUE)
)

s.q.irrad_label(
  unit.exponent = ifelse(normalized, 0, -6),
  format = getOption("photobiology.math", default = "R.expression"),
  label.text = axis_labels()[["s.q.irrad"]],
  scaled = FALSE,
  normalized = FALSE,
  axis.symbols = getOption("ggspectra.axis.symbols", default = TRUE)
)

Arguments

unit.exponent

integer.

format

character string, "R", "R.expresion", "R.character", or "LaTeX".

label.text

character Textual portion of the labels.

scaled

logical If TRUE relative units are assumed.

normalized

logical (FALSE) or numeric Normalization wavelength in manometers (nm).

axis.symbols

logical If TRUE symbols of the quantities are added to the name. Supported only by format = "R.expression".

Value

a character string or an R expression.

Examples

str(s.e.irrad_label())
#>  language "Spectral energy irradiance, " ~ italic(E)[lambda] ~ (plain("") * plain(W ~      m^{ ...
str(s.e.irrad_label(axis.symbols = FALSE))
#>  language "Spectral energy irradiance, " ~ (plain("") * plain(W ~ m^{     -2 ...
str(s.e.irrad_label(format = "R.expression"))
#>  language "Spectral energy irradiance, " ~ italic(E)[lambda] ~ (plain("") * plain(W ~      m^{ ...
str(s.e.irrad_label(format = "LaTeX"))
#>  chr "Spectral energy irradiance,  $E_{\\lambda}$ ($W m^{-2} nm^{-1})$)"


str(s.q.irrad_label())
#>  language "Spectral photon irradiance, " ~ italic(Q)[lambda] ~ (plain("µ") * mol ~      s^{ ...
str(s.q.irrad_label(axis.symbols = FALSE))
#>  language "Spectral photon irradiance, " ~ (plain("µ") * mol ~ s^{     -1 ...
str(s.q.irrad_label(format = "R.expression"))
#>  language "Spectral photon irradiance, " ~ italic(Q)[lambda] ~ (plain("µ") * mol ~      s^{ ...
str(s.q.irrad_label(format = "LaTeX"))
#>  chr "Spectral photon irradiance,  $Q_{\\lambda}$ ($$\\mu$\\mathrm{mol} s^{-1} m^{-2} nm^{-1}$)"