Calibration multipliers axis labels

Calibration multipliers axis labels. Output can be selected as character, expression (R default devices) or LaTeX (for tikz device).

Usage

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

Arguments

unit.exponent

integer

format

character string, "R", "R.expression", "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

multipliers_label()
#> "Pixel response multipliers," ~ italic(k)[lambda] ~ (plain(W ~ 
#>     m^{
#>         -2
#>     } ~ nm^{
#>     -1
#> } ~ counts^{
#>     -1
#> } ~ s))
multipliers_label(3)
#> "Pixel response multipliers," ~ italic(k)[lambda] ~ (10^{
#>     3
#> } * plain(W ~ m^{
#>     -2
#> } ~ nm^{
#>     -1
#> } ~ counts^{
#>     -1
#> } ~ s))
multipliers_label(format = "R.expression")
#> "Pixel response multipliers," ~ italic(k)[lambda] ~ (plain(W ~ 
#>     m^{
#>         -2
#>     } ~ nm^{
#>     -1
#> } ~ counts^{
#>     -1
#> } ~ s))
multipliers_label(format = "R.character")
#> [1] "Pixel response multipliers, k(lambda) (W m-2 nm-1 per counts/s)"
multipliers_label(format = "LaTeX")
#> [1] "Pixel response multipliers, $k_{\\lambda}$ ($W m^{-2} nm^{-1} \\mathrm{count}^{-1}~s$)"
multipliers_label(3, format = "LaTeX")
#> [1] "Pixel response multipliers, $k_{\\lambda}$ ($\\times 10^{3} W m^{-2} nm^{-1} \\mathrm{count}^{-1}~s$)"