R: Average area under curve for regions.

stat_wl_summary {ggspectra} | R Documentation

## Average area under curve for regions.

### Description

`stat_wl_summary` computes the area under a curve.

### Usage

    stat_wl_summary(mapping = NULL, data = NULL, geom = "text",
      range = NULL, integral.fun = integrate_xy, label.fmt = "%.3g",
      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
`range` | a numeric vector of at least length two.
`integral.fun` | function on $x$ and $y$.
`label.fmt` | character string giving a format definition for converting y-integral values into character strings by means of function `sprintf`.
`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.

### Computed variables

What it is named integral below is the result of appying `integral.fun`, with default `integrate_xy`.

y.label

  y formatted according to `label.fmt`

x

  w.band-midpoint

xmin

  range minimum

xmax

  range maximum

y

  data$y integral for the range by the spread of the range

### Default aesthetics

Set by the statistic and available to geoms.

label

  ..label..

x

  ..x..

xmin

  ..xmin..

xmax

  ..xmax..

y

  ..y..

ymin

  0

ymax

  ..y..

yintercept

  ..y..

### 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_irrad`, `stat_wb_label`, `stat_wb_mean`, `stat_wb_relative`, `stat_wb_sirrad`, `stat_wb_total`, `stat_wl_strip`

### Examples

    library(photobiology)
    library(ggplot2)
    # ggplot() methods for spectral objects set a default mapping for x and y.
    ggplot(sun.spct) + geom_line() +
      stat_wl_summary(geom = "hline")
    ggplot(sun.spct) + geom_line() +
      stat_wl_summary(label.fmt = "mean = %.3f", color = "red", vjust = -0.3) +
      stat_wl_summary(geom = "hline", color = "red")

[Package ggspectra version 0.2.3 Index]