R: Calculate colours from wavelength.

stat_wl_strip {ggspectra} | R Documentation

## Calculate colours from wavelength.

### Description

`stat_wl_strip` computes color definitions according to human vision.

### Usage

    stat_wl_strip(mapping = NULL, data = NULL, geom = "rect", type = "CMF",
      w.band = NULL, length.out = 150, position = "identity", na.rm = TRUE,
      show.legend = FALSE, inherit.aes = TRUE, ...)

    wl_guide(mapping = NULL, data = NULL, type = "CMF", w.band = NULL,
      length.out = 150, ymin = -Inf, ymax = Inf, position = "identity",
      na.rm = FALSE, show.legend = FALSE, 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
`type` | character one of "CMF" (color matching function) or "CC" (color coordinates).
`w.band` | waveband object or a list of such objects or NULL.
`length.out` | The number of steps to use to simulate a continuous range of colours when w.band == NULL.
`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.
`ymin, ymax` | numeric used as aesthetics for plotting the guide.

### Value

generic_spect object with new `x` values plus other computed variables described below.

### Computed variables

x

  (w.low + wl.high) / 2

wl.low

  boundary of waveband

wl.high

  boundary of waveband

wl.color

  color corresponding to wavelength

wb.color

  color corresponding to waveband

wb.name

  label of w.band

### Default aesthetics

Set by the statistic and available to geoms.

x

  ..x..

label

  as.character(..wb.f..)

xmin

  ..wl.low..

xmax

  ..wl.high..

fill

  ..wb.color..

### Required aesthetics

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

x

  numeric, wavelength in nanometres

### See Also

`color_of`, which is used internally.

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_summary`

### 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_strip(ymax = -0.02, ymin = -0.04) +
      scale_fill_identity()

    # on some graphic devices the output may show spurious vertical lines
    ggplot(sun.spct) + wl_guide(alpha = 0.33, color = NA) + geom_line()

[Package ggspectra version 0.2.3 Index]