stat_difference {ggh4x} | R Documentation |
Difference ribbon
Description
This makes a ribbon that is filled depending on whether the max
is
higher than min
. This can be useful for displaying differences
between two series.
Usage
stat_difference(
mapping = NULL,
data = NULL,
geom = "ribbon",
position = "identity",
...,
levels = c("+", "-", "0"),
na.rm = FALSE,
orientation = NA,
show.legend = NA,
inherit.aes = TRUE
)
Arguments
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) ).
|
geom |
Use to override the default connection between
geom_ribbon() and stat_difference() .
|
position |
Position adjustment, either as a string naming the adjustment
(e.g. "jitter" to use position_jitter ), or the result of a call to a
position adjustment function. Use the latter if you need to change the
settings of the adjustment.
|
... |
Other arguments passed on to layer() . These are
often aesthetics, used to set an aesthetic to a fixed value, like
colour = "red" or size = 3 . They may also be parameters
to the paired geom/stat.
|
levels |
A character(3) indicating factor levels for the fill
aesthetic for the following cases (1) max > min (2) max < min
(3) max == min . Will be padded with NA s when necessary.
|
na.rm |
If FALSE , the default, missing values are removed with
a warning. If TRUE , missing values are silently removed.
|
orientation |
The orientation of the layer. The default (NA )
automatically determines the orientation from the aesthetic mapping. In the
rare event that this fails it can be given explicitly by setting orientation
to either "x" or "y" . See the Orientation section for more detail.
|
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() .
|
Details
The stat may reorder the group
aesthetic to accommodate two
different fills for the signs of differences. The stat takes care to
interpolate a series whenever a crossover between max
and min
series
happens. This makes the ribbon not look stumpy at these crossovers.
Value
A Layer
object that can be added to a plot.
Aesthetics
geom_ribbon()
understands the following aesthetics (required aesthetics are in bold):
-
x
or y
-
ymin
or xmin
-
ymax
or xmax
-
alpha
-
colour
-
fill
-
group
-
linetype
-
linewidth
Learn more about setting these aesthetics in vignette("ggplot2-specs")
.
Computed variables
sign
A factor
with the levels
attribute set to the levels
argument.
Examples
set.seed(2021)
df <- data.frame(
x = 1:100,
y = cumsum(rnorm(100)),
z = cumsum(rnorm(100))
)
ggplot(df, aes(x = x)) +
stat_difference(aes(ymin = y, ymax = z), alpha = 0.3) +
geom_line(aes(y = y, colour = "min")) +
geom_line(aes(y = z, colour = "max"))
[Package
ggh4x version 0.2.4
Index]