A meta-stat for computing slab and interval functions for use with geom_slabinterval()
and its derivatives. Generally speaking not intended to be used directly: The API for
this stat is experimental and subject to change. This is used as the basis
for several other more directly useful stats whose APIs are more stable; it is recommended
to use those instead.
stat_slabinterval(
mapping = NULL,
data = NULL,
geom = "slabinterval",
position = "identity",
...,
orientation = NA,
limits_function = NULL,
limits_args = list(),
limits = NULL,
slab_function = NULL,
slab_args = list(),
n = 501,
interval_function = NULL,
interval_args = list(),
point_interval = NULL,
.width = c(0.66, 0.95),
show_slab = TRUE,
show_interval = TRUE,
na.rm = FALSE,
show.legend = c(size = FALSE),
inherit.aes = TRUE
)The data to be displayed in this layer. There are three options:
If NULL, the default, the data is inherited from the plot
data as specified in the call to ggplot().
A data.frame, or other object, will override the plot
data. All objects will be fortified to produce a data frame. See
fortify() for which variables will be created.
A function will be called with a single argument,
the plot data. The return value must be a data.frame, and
will be used as the layer data. A function can be created
from a formula (e.g. ~ head(.x, 10)).
Use to override the default connection between
stat_slabinterval and geom_slabinterval()
Position adjustment, either as a string, or the result of a call to a position adjustment function.
Other arguments passed to layer(). They may also be arguments to the paired geom
(e.g., geom_pointinterval())
Whether this geom is drawn horizontally ("horizontal") or
vertically ("vertical"). The default, NA, automatically detects the orientation based on how the
aesthetics are assigned, and should generally do an okay job at this. When horizontal (resp. vertical),
the geom uses the y (resp. x) aesthetic to identify different groups, then for each group uses
the x (resp. y) aesthetic and the thickness aesthetic to draw a function as an slab, and draws
points and intervals horizontally (resp. vertically) using the xmin, x, and xmax (resp.
ymin, y, and ymax) aesthetics. For compatibility with the base
ggplot naming scheme for orientation, "x" can be used as an alias for "vertical" and "y" as an alias for
"horizontal" (tidybayes had an orientation parameter before ggplot did, and I think the tidybayes naming
scheme is more intuitive: "x" and "y" are not orientations and their mapping to orientations is, in my
opinion, backwards; but the base ggplot naming scheme is allowed for compatibility).
A function that takes a data frame of aesthetics and returns a data frame with
columns .lower and .upper indicating the limits of the input for the slab function for that data frame.
The function may additionally take a trans argument which will be passed the scale
transformation object applied to the coordinate space.
Additional arguments passed to limits_function
Limits for slab_function, as a vector of length two. These limits are combined with those
computed by the limits_function as well as the limits defined by the scales of the plot to determine the
limits used to draw the slab functions: these limits specify the maximal limits; i.e., if specified, the limits
will not be wider than these (but may be narrower). Use NA to leave a limit alone; e.g.
limits = c(0, NA) will ensure that the lower limit does not go below 0.
A function that takes a data frame of aesthetics and an input parameter (a vector
of function inputs), and returns a data frame with
columns .input (from the input vector) and .value (result of applying the function to
each value of input). Given the results of slab_function, .value will be translated into the
f aesthetic and input will be translated into either the x or y aesthetic
automatically depending on the value of orientation.
Additional arguments passed to limits_function
Number of points at which to evaluate slab_function
Custom function for generating intervals (for most common use cases the point_interval
argument will be easier to use). This function takes a data frame of aesthetics and a .width parameter (a vector
of interval widths), and returns a data frame with
columns .width (from the .width vector), .value (point summary) and .lower and .upper
(endpoints of the intervals, given the .width). Output will be converted to the appropriate x- or
y-based aesthetics depending on the value of orientation. If interval_function is NULL,
point_interval is used instead.
Additional arguments passed to interval_function or point_interval.
A function from the point_interval() family (e.g., median_qi,
mean_qi, etc). This function should take in a vector of value, and should obey the
.width and .simple_names parameters of point_interval() functions, such that when given
a vector with .simple_names = TRUE should return a data frame with variables .value, .lower,
.upper, and .width. Output will be converted to the appropriate x- or y-based aesthetics
depending on the value of orientation. See the point_interval() family of functions for
more information.
The .width argument passed to interval_function or point_interval.
Should the slab portion of the geom be drawn? Default TRUE.
Should the interval portion of the geom be drawn? Default TRUE.
If FALSE, the default, missing values are removed with a warning. If TRUE, missing
values are silently removed.
Should this layer be included in the legends? Default is c(size = FALSE), unlike most geoms,
to match its common use cases. FALSE hides all legends, TRUE shows all legends, and NA shows only
those that are mapped (the default for most geoms).
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().
These stats support the following aesthetics:
x
y
datatype
thickness
size
group
In addition, in their default configuration (paired with geom_slabinterval()) the following aesthetics are supported by the underlying geom:
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").
See geom_slabinterval() for the geom version, intended
for use on data that has already been translated into function evaluations, points, and intervals.
See stat_sample_slabinterval() and stat_dist_slabinterval() for families of stats
built on top of this stat for common use cases (like stat_halfeye).
See vignette("slabinterval") for a variety of examples of use.
# NOT RUN {
# stat_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
# stat_slabinterval() directly.
# }
Run the code above in your browser using DataLab