Generate cps axis labels in SI units, using SI scale factors. Output can be selected as character, expression (R default devices) or LaTeX (for tikz device).
Usage
Afr_label(
unit.exponent = ifelse(pc.out, -2, 0),
format = getOption("photobiology.math", default = "R.expression"),
label.text = axis_labels()[["s.Afr"]],
scaled = FALSE,
normalized = FALSE,
axis.symbols = getOption("ggspectra.axis.symbols", default = TRUE),
pc.out = getOption("ggspectra.pc.out", default = FALSE)
)
Rfr_total_label(
unit.exponent = ifelse(pc.out, -2, 0),
format = getOption("photobiology.math", default = "R.expression"),
label.text = NULL,
scaled = FALSE,
normalized = FALSE,
axis.symbols = getOption("ggspectra.axis.symbols", default = TRUE),
pc.out = getOption("ggspectra.pc.out", default = FALSE)
)
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 thename
. Supported only byformat = "R.expression"
.- pc.out
logical, if TRUE use percent as default instead of fraction of one.
Examples
Afr_label()
#> "Spectral absorptance, " ~ alpha[lambda] ~ ~plain("(/1)")
Afr_label(format = "R.expression", axis.symbols = FALSE)
#> "Spectral absorptance, " ~ ~plain("(/1)")
Afr_label(-2)
#> "Spectral absorptance, " ~ alpha[lambda] ~ ~plain("(%)")
Afr_label(-3)
#> "Spectral absorptance, " ~ alpha[lambda] ~ ~plain("(permil)")
Afr_label(format = "R.expression")
#> "Spectral absorptance, " ~ alpha[lambda] ~ ~plain("(/1)")
Afr_label(format = "LaTeX")
#> [1] "Spectral absorptance, $\\alpha_{\\lambda}$ (/1)"
Afr_label(-2, format = "LaTeX")
#> [1] "Spectral absorptance, $\\alpha_{\\lambda}$ (\\%)"
Rfr_total_label()
#> "Total spectral reflectance, " ~ rho[lambda] ~ plain("(/1)")
Rfr_total_label(axis.symbols = FALSE)
#> "Total spectral reflectance, " ~ plain("(/1)")
Rfr_total_label(-2)
#> "Total spectral reflectance, " ~ rho[lambda] ~ plain("(%)")
Rfr_total_label(-3)
#> "Total spectral reflectance, " ~ rho[lambda] ~ plain("(permil)")
Rfr_total_label(format = "R.expression")
#> "Total spectral reflectance, " ~ rho[lambda] ~ plain("(/1)")
Rfr_total_label(format = "LaTeX")
#> [1] "Total spectral reflectance, $\\rho_{\\lambda}$ (/1)"
Rfr_total_label(-3, format = "LaTeX")
#> [1] "Total spectral reflectance, $\\rho_{\\lambda}$ (permil)"