- mapping
Set of aesthetic mappings created by aes()
. If specified and
inherit.aes = TRUE
(the default), it is combined with the default mapping
at the top level of the plot. You must supply mapping
if there is no plot
mapping.
- data
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)
).
- stat
The statistical transformation to use on the data for this
layer, either as a ggproto
Geom
subclass or as a string naming the
stat stripped of the stat_
prefix (e.g. "count"
rather than
"stat_count"
)
- position
Position adjustment, either as a string, or the result of a call to a position adjustment function.
Setting this equal to "dodge"
(position_dodge()
) or "dodgejust"
(position_dodgejust()
) can be useful if
you have overlapping geometries.
- ...
Other arguments passed to layer()
. These are often aesthetics, used to set an aesthetic
to a fixed value, like colour = "red"
or linewidth = 3
(see Aesthetics, below). They may also be
parameters to the paired geom/stat.
- arrow
grid::arrow()
giving the arrow heads to use on the spike, or NULL
for no arrows.
- orientation
Whether this geom is drawn horizontally or vertically. One of:
NA
(default): automatically detect the orientation based on how the aesthetics
are assigned. Automatic detection works most of the time.
"horizontal"
(or "y"
): draw horizontally, using the y
aesthetic to identify different
groups. For each group, uses the x
, xmin
, xmax
, and thickness
aesthetics to
draw points, intervals, and slabs.
"vertical"
(or "x"
): draw vertically, using the x
aesthetic to identify different
groups. For each group, uses the y
, ymin
, ymax
, and thickness
aesthetics to
draw points, intervals, and slabs.
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"
(ggdist had an orientation
parameter
before base ggplot did, hence the discrepancy).
- normalize
How to normalize heights of functions input to the thickness
aesthetic. One of:
"all"
: normalize so that the maximum height across all data is 1
.
"panels"
: normalize within panels so that the maximum height in each panel is 1
.
"xy"
: normalize within the x/y axis opposite the orientation
of this geom so
that the maximum height at each value of the opposite axis is 1
.
"groups"
: normalize within values of the opposite axis and within each
group so that the maximum height in each group is 1
.
"none"
: values are taken as is with no normalization (this should probably
only be used with functions whose values are in [0,1], such as CDFs).
- na.rm
If FALSE
, the default, missing values are removed with a warning. If TRUE
, missing
values are silently removed.
- show.legend
logical. Should this layer be included in the legends?
NA
, the default, includes if any aesthetics are mapped.
FALSE
never includes, and TRUE
always includes.
It can also be a named logical vector to finely select the aesthetics to
display.
- 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()
.