stat_wb_total
computes integral under a curve. Sets suitable default
aesthetics for "rect", "hline", "vline", "text" and "label" geoms displaying
"totals" per waveband. x
-scale transformations and axis
flipping are currently not supported.
Usage
stat_wb_total(
mapping = NULL,
data = NULL,
geom = "text",
position = "identity",
...,
w.band = NULL,
integral.fun = integrate_xy,
label.mult = 1,
chroma.type = "CMF",
label.fmt = "%.3g",
ypos.mult = 1.07,
ypos.fixed = NULL,
na.rm = FALSE,
show.legend = NA,
inherit.aes = TRUE
)
Arguments
- mapping
The aesthetic mapping, usually constructed with
aes
oraes_
. 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
- position
The position adjustment to use for overlapping points on this layer
- ...
other arguments passed on to
layer
. This can include aesthetics whose values you want to set, not map. Seelayer
for more details.- w.band
a waveband object or a list of waveband objects or numeric vector of at least length two.
- integral.fun
function on $x$ and $y$.
- label.mult
numeric Scaling factor applied to y-integral values before conversion into character strings.
- chroma.type
character one of "CMF" (color matching function) or "CC" (color coordinates) or a
chroma_spct
object.- 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 iny
.- 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, andTRUE
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
.
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 integral.fun
,
with default integrate_xy
.
- y.label
ymean multiplied by
label.mult
and formatted according tolabel.fmt
- x
w.band-midpoint
- wb.xmin
w.band minimum
- wb.xmax
w.band maximum
- wb.ymin
data$y minimum
- wb.ymax
data$y maximum
- wb.yint
data$y integral for the range of
w.band
- wb.xmean
yint divided by wl_expanse(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
..wb.xmin..
- xmax
..wb.xmax..
- ymin
..y.. - (..wb.ymax.. - ..wb.ymin..) * 0.03
- ymax
..y.. + (..wb.ymax.. - ..wb.ymin..) * 0.03
- yintercept
..wb.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_find_qtys()
,
stat_find_wls()
,
stat_label_peaks()
,
stat_peaks()
,
stat_spikes()
,
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_wl_strip()
,
stat_wl_summary()
Examples
library(photobiologyWavebands)
# ggplot() methods for spectral objects set a default mapping for x and y.
ggplot(sun.spct) +
geom_line() +
stat_wb_box(w.band = VIS()) +
stat_wb_total(w.band = VIS()) +
scale_fill_identity() + scale_color_identity()
ggplot(sun.spct) +
geom_line() +
stat_wb_box(w.band = UV_bands(), color = "white") +
stat_wb_total(w.band = UV_bands()) +
scale_fill_identity() + scale_color_identity()