Draw colour boxes for wavebands

stat_wb_box plots boxes corresponding to wavebands, by default located slightly above the peak of the spectrum. Sets suitable default aesthetics for geom_rect(). x-scale transformations and axis flipping are currently not supported.

Usage

stat_wb_box(
  mapping = NULL,
  data = NULL,
  geom = "rect",
  position = "identity",
  ...,
  by.group = FALSE,
  w.band = NULL,
  chroma.type = "CMF",
  ypos.mult = 1.07,
  ypos.fixed = NULL,
  box.height = 0.06,
  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

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. See layer for more details.

by.group

logical flag If TRUE repeated identical layers are added for each group within a plot panel as needed for animation. If FALSE, the default, a single layer is added per panel.

w.band

a waveband object or a list of waveband objects or numeric vector of at least length two.

chroma.type

character one of "CMF" (color matching function) or "CC" (color coordinates) or a chroma_spct object.

ypos.mult

numeric Multiplier constant used to compute returned y values. This is numerically similar to using npc units, but values larger than one expand the plotting area.

ypos.fixed

numeric If not NULL used a constant value returned in y.

box.height

numeric The height of the box as a fraction of the range of $y$. This is similar to using npc units.

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.

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.

Details

By default stat_wb_box() uses a panel function and ignores grouping as needed for annotation of layers supporting free axis scales. Passing by.group = TRUE as argument changes this behaviour adding the same layer repeatedly for each group as needed for constructing animated plots with functions from package 'gganimate'.

The value returned as default value for y is based on the y-range of spectral values for the whole data set.

As colours are returned as RGB colour definitions, depending on the geometry used the use of scale_fill_identity and/or scale_colour_identity can be necessary for the correct colours to be displayed in the plot.

Note

As only one colour scale can exist within a "gg" object, using this scale prevents the mapping to the colour aesthetic of factors in data to create a grouping.

Computed variables

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

x

w.band-midpoint

wb.xmin

w.band minimum

wb.xmax

w.band maximum

wb.ymin

data$y minimum

wb.ymax

data$y maximum

ymin

box bottom

ymax

box top

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.

xmin

stat(wb.xmin)

xmax

stat(wb.xmax)

ymin

stat(ymin)

ymax

stat(ymax)

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

fast_color_of_wb, which is used in the implementation.

Other stats functions: stat_color(), stat_find_qtys(), stat_find_wls(), stat_label_peaks(), stat_peaks(), stat_spikes(), 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(), stat_wl_summary()

Examples

library(photobiologyWavebands)
# ggplot() methods for spectral objects set a default mapping for x and y.
ggplot(sun.spct) +
  stat_wb_box(w.band = VIS_bands()) +
  geom_line() +
  scale_fill_identity()

ggplot(sun.spct) +
  stat_wb_box(w.band = VIS_bands(), color = "white") +
  geom_line() +
  scale_fill_identity()