R: Integrate irradiance for wavebands.

stat_wb_irrad {ggspectra} | R Documentation

## Integrate irradiance for wavebands.

### Description

`stat_wb_irrad` computes areas under a curve.

### Usage

    stat_wb_irrad(mapping = NULL, data = NULL, geom = "text", w.band = NULL,
      time.unit, unit.in, label.qty = "total", label.mult = 1,
      label.fmt = "%.3g", ypos.mult = 1.07, ypos.fixed = NULL,
      position = "identity", na.rm = FALSE, show.legend = NA,
      inherit.aes = TRUE, ...)

    stat_wb_e_irrad(mapping = NULL, data = NULL, geom = "text",
      w.band = NULL, time.unit = "second", unit.in = "energy",
      label.qty = "total", label.mult = 1, label.fmt = "%.3g",
      ypos.mult = 1.07, ypos.fixed = NULL, position = "identity",
      na.rm = FALSE, show.legend = NA, inherit.aes = TRUE, ...)

    stat_wb_q_irrad(mapping = NULL, data = NULL, geom = "text",
      w.band = NULL, time.unit = "second", unit.in = "photon",
      label.qty = "total", label.mult = 1, label.fmt = "%.3g",
      ypos.mult = 1.07, ypos.fixed = NULL, position = "identity",
      na.rm = FALSE, show.legend = NA, inherit.aes = TRUE, ...)

### Arguments

`mapping` | The aesthetic mapping, usually constructed with `aes` or `aes_`. Only needs to be set at the layer level if you are overriding the plot defaults.
`data` | A layer specific dataset - only needed if you want to override the plot defaults.
`geom` | The geometric object to use display the data
`w.band` | a waveband object or a list of waveband objects or numeric vector of at least length two.
`time.unit` | character or lubridate::duration
`unit.in` | character One of "photon","quantum" or "energy"
`label.qty` | character
`label.mult` | numeric Scaling factor applied to y-integral values before conversion into character strings.
`label.fmt` | character string giving a format definition for converting y-integral values into character strings by means of function `sprintf`.
`ypos.mult` | numeric Multiplier constant used to scale returned `y` values.
`ypos.fixed` | numeric If not `NULL` used a constant value returned in `y`.
`position` | The position adjustment to use for overlapping points on this layer
`na.rm` | a logical value indicating whether NA values should be stripped before the computation proceeds.
`show.legend` | logical. Should this layer be included in the legends? `NA`, the default, includes if any aesthetics are mapped. `FALSE` never includes, and `TRUE` always includes.
`inherit.aes` | If `FALSE`, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. `borders`.
`...` | other arguments passed on to `layer`. This can include aesthetics whose values you want to set, not map. See `layer` for more details.

### Value

A data frame with one row for each waveband object in the argument to `w.band`. Wavebeand outside the range of the spectral data are trimmed or discarded.

### Computed variables

What it is named integral below is the result of appying `irrad`, `e_irrad` or `q_irrad` to the data.

y.label

  yeff multiplied by `label.mult` and formatted according to `label.fmt`

x

  w.band-midpoint

xmin

  w.band minimum

xmax

  w.band maximum

ymin

  data$y minimum

ymax

  data$y maximum

yeff

  weighted irradiance if `w.band` describes a BSWF

yint

  not weighted irradiance for the range of `w.band`

xmean

  yint divided by spread(w.band)

y

  ypos.fixed or top of data, adjusted by `ypos.mult`

wb.color

  color of the w.band

wb.name

  label of w.band

BW.color

  `black_or_white(wb.color)`

### Default aesthetics

Set by the statistic and available to geoms.

label

  ..y.label..

x

  ..x..

xmin

  ..xmin..

xmax

  ..xmax..

ymin

  ..y.. - (..ymax.. - ..ymin..) * 0.03

ymax

  ..y.. + (..ymax.. - ..ymin..) * 0.03

yintercept

  ..ymean..

fill

  ..wb.color..

### Required aesthetics

Required by the statistic and need to be set with `aes()`.

x

  numeric, wavelength in nanometres

y

  numeric, a spectral quantity

### See Also

Other stats functions: `stat_color`, `stat_label_peaks`, `stat_peaks`, `stat_wb_box`, `stat_wb_column`, `stat_wb_contribution`, `stat_wb_hbar`, `stat_wb_label`, `stat_wb_mean`, `stat_wb_relative`, `stat_wb_sirrad`, `stat_wb_total`, `stat_wl_strip`, `stat_wl_summary`

### Examples

    library(photobiology)
    library(photobiologyWavebands)
    library(ggplot2)
    # ggplot() methods for spectral objects set a default mapping for x and y.
    ggplot(sun.spct) +
      stat_wb_column(w.band = VIS_bands()) +
      stat_wb_e_irrad(w.band = VIS_bands(),
                      angle = 90, size = 4,
                      label.fmt = "%2.0f", ypos.fixed = 0.1) +
      geom_line() +
      scale_fill_identity() + scale_color_identity()

    ggplot(sun.spct) +
      stat_wb_box(w.band = VIS_bands()) +
      stat_wb_e_irrad(w.band = VIS_bands(),
                      angle = 90, size = 4,
                      label.fmt = "%2.0f") +
      geom_line() +
      scale_fill_identity() + scale_color_identity()

[Package ggspectra version 0.2.3 Index]