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, fluence or exposure 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 = NULL,
  markup.format = getOption("photobiology.math", default = "R.expression"),
  time.unit = "second",
  label.text = NULL,
  pc.out = FALSE,
  scaled = FALSE,
  normalised = FALSE,
  normalized = normalised,
  axis.symbols = getOption("ggspectra.axis.symbols", default = TRUE)
)

s.q.irrad_label(
  unit.exponent = NULL,
  markup.format = getOption("photobiology.math", default = "R.expression"),
  time.unit = "second",
  label.text = NULL,
  pc.out = FALSE,
  scaled = FALSE,
  normalised = FALSE,
  normalized = normalised,
  axis.symbols = getOption("ggspectra.axis.symbols", default = TRUE)
)

Arguments

unit.exponent	integer. The default is guessed from time.unit, scaled and normalized.
markup.format	character string, "R", "R.expresion", "r.character", or "LaTeX".
time.unit	character or duration The length of time used as base of expression.
label.text	character Textual portion of the labels.
pc.out	logical Flag to enable display of normalised data as percentages.
scaled	logical If TRUE relative units are assumed.
normalized, normalised	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())
str(s.e.irrad_label(axis.symbols = FALSE))
str(s.e.irrad_label(markup.format = "R.expression"))
str(s.e.irrad_label(markup.format = "LaTeX"))
str(s.e.irrad_label(markup.format = "R.character"))

str(s.q.irrad_label())
str(s.q.irrad_label(axis.symbols = FALSE))
str(s.q.irrad_label(markup.format = "R.expression"))
str(s.q.irrad_label(markup.format = "LaTeX"))
str(s.q.irrad_label(markup.format = "R.character"))

aphalo/ggspectra documentation built on June 10, 2025, 4:56 p.m.