tidybayes (version 0.12.1.9000)

geom_lineribbon: Line + multiple probability ribbon plots (ggplot geom)

Description

A combination of geom_line and geom_ribbon with default aesthetics designed for use with output from point_interval.

Usage

geom_lineribbon(mapping = NULL, data = NULL, stat = "identity",
  position = "identity", ..., na.rm = FALSE, show.legend = NA,
  inherit.aes = TRUE)

Arguments

mapping

The aesthetic mapping, usually constructed with aes or aes_string. 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.

stat

The statistical transformation to use on the data for this layer.

position

The position adjustment to use for overlapping points on this layer.

...

Other arguments passed to layer.

na.rm

If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

show.legend

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.

Details

geom_lineribbon is a combination version of a geom_line, and geom_ribbon designed for use with output from point_interval. This geom sets some default aesthetics equal to the conf.low, conf.high, and .prob columns generated by the point_interval family of functions, making them often more convenient than a vanilla geom_ribbon + geom_line.

Specifically, geom_lineribbon acts as if its default aesthetics are aes(ymin = conf.low, ymax = conf.high, size = -.prob).

See Also

See stat_lineribbon for a version that does summarizing of samples into estimate and intervals within ggplot. See geom_pointinterval / geom_pointintervalh for a similar geom intended for point estimates and intervals. See geom_ribbon and geom_line for the geoms this is based on.

Examples

# NOT RUN {
library(dplyr)
library(ggplot2)

data_frame(x = 1:10) %>%
  group_by_all() %>%
  do(data_frame(y = rnorm(100, .$x))) %>%
  median_qi(.prob = c(.5, .8, .95)) %>%
  ggplot(aes(x = x, y = y)) +
  # automatically uses aes(ymin = conf.low, ymax = conf.high, fill = fct_rev(ordered(.prob)))
  geom_lineribbon() +
  scale_fill_brewer()

# }