geom_lineribbon | R Documentation |
A combination of geom_line()
and geom_ribbon()
with default aesthetics
designed for use with output from point_interval()
.
geom_lineribbon(
mapping = NULL,
data = NULL,
stat = "identity",
position = "identity",
...,
step = FALSE,
orientation = NA,
na.rm = FALSE,
show.legend = NA,
inherit.aes = TRUE
)
mapping |
Set of aesthetic mappings created by |
data |
The data to be displayed in this layer. There are three options: If A A |
stat |
The statistical transformation to use on the data for this
layer, either as a |
position |
Position adjustment, either as a string naming the adjustment
(e.g. |
... |
Other arguments passed to |
step |
Should the line/ribbon be drawn as a step function? One of:
|
orientation |
Whether this geom is drawn horizontally or vertically. One of:
For compatibility with the base ggplot naming scheme for |
na.rm |
If |
show.legend |
logical. Should this layer be included in the legends?
|
inherit.aes |
If |
geom_lineribbon()
is a combination of a geom_line()
and geom_ribbon()
designed for use
with output from point_interval()
. This geom sets some default aesthetics equal to the .width
column 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(fill = forcats::fct_rev(ordered(.width)))
.
A ggplot2::Geom representing a combined line + multiple-ribbon geometry which can
be added to a ggplot()
object.
The line+ribbon stat
s and geom
s have a wide variety of aesthetics that control
the appearance of their two sub-geometries: the line and the ribbon.
Positional aesthetics
x
: x position of the geometry
y
: y position of the geometry
Ribbon-specific aesthetics
xmin
: Left edge of the ribbon sub-geometry (if orientation = "horizontal"
).
xmax
: Right edge of the ribbon sub-geometry (if orientation = "horizontal"
).
ymin
: Lower edge of the ribbon sub-geometry (if orientation = "vertical"
).
ymax
: Upper edge of the ribbon sub-geometry (if orientation = "vertical"
).
order
: The order in which ribbons are drawn. Ribbons with the smallest mean value of order
are drawn first (i.e., will be drawn below ribbons with larger mean values of order
). If
order
is not supplied to geom_lineribbon()
, -abs(xmax - xmin)
or -abs(ymax - ymax)
(depending on orientation
) is used, having the effect of drawing the widest (on average)
ribbons on the bottom. stat_lineribbon()
uses order = after_stat(level)
by default,
causing the ribbons generated from the largest .width
to be drawn on the bottom.
Color aesthetics
colour
: (or color
) The color of the line sub-geometry.
fill
: The fill color of the ribbon sub-geometry.
alpha
: The opacity of the line and ribbon sub-geometries.
fill_ramp
: A secondary scale that modifies the fill
scale to "ramp" to another color. See scale_fill_ramp()
for examples.
Line aesthetics
linewidth
: Width of line. In ggplot2 < 3.4, was called size
.
linetype
: Type of line (e.g., "solid"
, "dashed"
, etc)
Other aesthetics (these work as in standard geom
s)
group
See examples of some of these aesthetics in action in vignette("lineribbon")
.
Learn more about the sub-geom override aesthetics (like interval_color
) in the
scales documentation. Learn more about basic ggplot aesthetics in
vignette("ggplot2-specs")
.
Matthew Kay
See stat_lineribbon()
for a version that does summarizing of samples into points and intervals
within ggplot. See geom_pointinterval()
for a similar geom intended
for point summaries and intervals. See geom_ribbon()
and geom_line()
for the geoms this is
based on.
library(dplyr)
library(ggplot2)
theme_set(theme_ggdist())
set.seed(12345)
tibble(
x = rep(1:10, 100),
y = rnorm(1000, x)
) %>%
group_by(x) %>%
median_qi(.width = c(.5, .8, .95)) %>%
ggplot(aes(x = x, y = y, ymin = .lower, ymax = .upper)) +
# automatically uses aes(fill = forcats::fct_rev(ordered(.width)))
geom_lineribbon() +
scale_fill_brewer()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.