Slab + point + interval meta-geom
This meta-geom supports drawing combinations of functions (as slabs, aka ridge plots or joy plots), points, and
intervals. It acts as a meta-geom for many other tidybayes geoms that are wrappers around this geom, including
eye plots, half-eye plots, CCDF barplots, and point+multiple interval plots, and supports both horizontal and
vertical orientations, dodging (via the position
argument), and relative justification of slabs with their
corresponding intervals.
geom_slabinterval( mapping = NULL, data = NULL, stat = "identity", position = "identity", ..., side = c("topright", "top", "right", "bottomleft", "bottom", "left", "topleft", "bottomright", "both"), scale = 0.9, orientation = NA, justification = NULL, normalize = c("all", "panels", "xy", "groups", "none"), interval_size_domain = c(1, 6), interval_size_range = c(0.6, 1.4), fatten_point = 1.8, show_slab = TRUE, show_point = TRUE, show_interval = TRUE, na.rm = FALSE, show.legend = NA, inherit.aes = TRUE ) geom_slab( mapping = NULL, data = NULL, stat = "identity", position = "identity", ..., 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, as a string. |
position |
Position adjustment, either as a string, or the result of a call to a position adjustment function. |
... |
Other arguments passed to |
side |
Which side to draw the slab on. |
scale |
What proportion of the region allocated to this geom to use to draw the slab. If |
orientation |
Whether this geom is drawn horizontally ( |
justification |
Justification of the interval relative to the slab, where |
normalize |
How to normalize heights of functions input to the |
interval_size_domain |
The minimum and maximum of the values of the size aesthetic that will be translated into actual
sizes for intervals drawn according to |
interval_size_range |
(Deprecated). This geom scales the raw size aesthetic values when drawing interval and point sizes, as
they tend to be too thick when using the default settings of |
fatten_point |
A multiplicative factor used to adjust the size of the point relative to the size of the
thickest interval line. If you wish to specify point sizes directly, you can also use the |
show_slab |
Should the slab portion of the geom be drawn? Default |
show_point |
Should the point portion of the geom be drawn? Default |
show_interval |
Should the interval portion of the geom be drawn? Default |
na.rm |
If |
show.legend |
logical. Should this layer be included in the legends?
|
inherit.aes |
If |
geom_slabinterval
is a flexible meta-geom that you can use directly or through a variety of "shortcut"
geoms that represent useful combinations of the various parameters of this geom. In many cases you will want to
use the shortcut geoms instead as they create more useful mnemonic primitives, such as eye plots,
half-eye plots, point+interval plots, or CCDF barplots.
The slab portion of the geom is much like a ridge or "joy" plot: it represents the value of a function
scaled to fit between values on the x or y access (depending on the value of orientation
). Values of
the functions are specified using the thickness
aesthetic and are scaled to fit into scale
times the distance between points on the relevant axis. E.g., if orientation
is "horizontal"
,
scale
is 0.9, and y
is a discrete variable, then the thickness
aesthetic specifies the
value of some function of x
that is drawn for every y
value and scaled to fit into 0.9 times
the distance between points on the y axis.
For the interval portion of the geom, x
and y
aesthetics specify the location of the
point and ymin
/ymax
or xmin
/xmax
(depending on the value of orientation
specifying the endpoints of the interval. A scaling factor for interval line width and point size is applied
through the interval_size_domain
, interval_size_range
, and fatten_point
parameters.
These scaling factors are designed to give multiple uncertainty intervals reasonable
scaling at the default settings for scale_size_continuous()
.
As a combination geom, this geom expects a datatype
aesthetic specifying which part of the geom a given
row in the input data corresponds to: "slab"
or "interval"
. However, specifying this aesthetic
manually is typically only necessary if you use this geom directly; the numerous wrapper geoms will
usually set this aesthetic for you as needed, and their use is recommended unless you have a very custom
use case.
Wrapper geoms and stats include:
stat_sample_slabinterval()
and associated stats
stat_dist_slabinterval()
and associated stats
Typically, the geom_*
versions are meant for use with already-summarized data (such as intervals) and the
stat_*
versions are summarize the data themselves (usually draws from a distribution) to produce the geom.
A ggplot2::Geom representing a slab or combined slab+interval geometry which can
be added to a ggplot()
object.
These geoms support the following aesthetics:
x
y
datatype
alpha
colour
colour_ramp
linetype
fill
shape
stroke
point_colour
point_fill
point_alpha
point_size
size
interval_colour
interval_alpha
interval_size
interval_linetype
slab_size
slab_colour
slab_fill
slab_alpha
slab_linetype
fill_ramp
ymin
ymax
xmin
xmax
width
height
thickness
group
See examples of some of these aesthetics in action in vignette("slabinterval")
.
Learn more about the sub-geom aesthetics (like interval_color
) in the scales documentation.
Learn more about basic ggplot aesthetics in vignette("ggplot2-specs")
.
Matthew Kay
See geom_lineribbon()
for a combination geom designed for fit curves plus probability bands.
See stat_sample_slabinterval()
and stat_dist_slabinterval()
for families of stats
built on top of this geom for common use cases (like stat_halfeye()
).
See vignette("slabinterval")
for a variety of examples of use.
# geom_slabinterval() is typically not that useful on its own. # See vignette("slabinterval") for a variety of examples of the use of its # shortcut geoms and stats, which are more useful than using # geom_slabinterval() directly.
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.