s.e.irrad_label: Spectral irradiance axis labels

In aphalo/ggspectra: Extensions to 'ggplot2' for Radiation Spectra

Spectral irradiance axis labels

Description

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,
  add.symbols = getOption("ggspectra.add.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,
  add.symbols = getOption("ggspectra.add.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).
add.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())
str(s.e.irrad_label(add.symbols = FALSE))
str(s.e.irrad_label(format = "R.expression"))
str(s.e.irrad_label(format = "LaTeX"))


str(s.q.irrad_label())
str(s.q.irrad_label(add.symbols = FALSE))
str(s.q.irrad_label(format = "R.expression"))
str(s.q.irrad_label(format = "LaTeX"))

aphalo/ggspectra documentation built on April 28, 2024, 5:22 a.m.