Error — fig_error • g2r

Add an error bar figure to the chart.

fig_error(
  g,
  ...,
  sync = TRUE,
  data = NULL,
  inherit_asp = TRUE,
  alias = "error"
)

Arguments

g	An object of class `g2r` or `g2Proxy` as returned by `g2()` or `g2_proxy()`.
...	Options to pass to the figure, including `asp()`, and `adjust()`, `active()`, `selected()`, and `config()`, other key value pairs of are passed to style.
sync	Whether to sync the axis data (align) with that used in other figures, set to `FALSE` to not sync or set to a character string to use as name of sync group.
data	A dataset (`data.frame` or `tibble`) to use to draw the figure.
inherit_asp	Whether to inherit the aspects paseed to `g2()` initialisation function.
alias	Name of the range to display on tooltips, labels, etc.

Details

Requires the ymin and ymax aspects, the width of the error bars can be changed with the size aspect.

Examples

df <- data.frame(
  x = as.factor(c(1:10, 1:10)),
  y = runif(20, 10, 15),
  grp = rep(c("A", "B"), each = 2)
)

df$ymin <- df$y - runif(20, 1, 2)
df$ymax <- df$y + runif(20, 1, 2)

g2(df, asp(x = x, color = grp)) %>%
  fig_error(asp(ymin = ymin, ymax = ymax), adjust("dodge")) %>%
  fig_interval(
    asp(y = y),
    adjust("dodge"),
    fillOpacity = .4
  )