+
+
+
![[Experimental]](figures/lifecycle-experimental.svg)
+Provides stair-step values for ribbon plots, often using in
+conjunction with ggplot2::geom_step().
+The step ribbon can be added with stat_stepribbon() or
+identically with ggplot2::geom_ribbon(stat = "stepribbon")
+
+
Usage
+
stat_stepribbon(
+ mapping = NULL,
+ data = NULL,
+ geom = "ribbon",
+ position = "identity",
+ na.rm = FALSE,
+ show.legend = NA,
+ inherit.aes = TRUE,
+ direction = "hv",
+ ...
+)
+
+StatStepribbon
+
+
+
An object of class StatStepRibbon (inherits from Stat, ggproto, gg) of length 3.
+
+
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
+which geom to use; defaults to "ribbon"
- 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.
- 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().
- direction
+hv for horizontal-vertical steps, vh for
+vertical-horizontal steps
- ...
+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.
+
Examples
+
# using ggplot2::geom_ribbon()
+survival::survfit(survival::Surv(time, status) ~ 1, data = survival::lung) %>%
+ survival::survfit0() %>%
+ broom::tidy() %>%
+ ggplot2::ggplot(ggplot2::aes(x = time, y = estimate, ymin = conf.low, ymax = conf.high)) +
+ ggplot2::geom_step() +
+ ggplot2::geom_ribbon(stat = "stepribbon", alpha = 0.2)
+
+
+# using stat_stepribbon() with the same result
+survival::survfit(survival::Surv(time, status) ~ 1, data = survival::lung) %>%
+ survival::survfit0() %>%
+ broom::tidy() %>%
+ ggplot2::ggplot(ggplot2::aes(x = time, y = estimate, ymin = conf.low, ymax = conf.high)) +
+ ggplot2::geom_step() +
+ visR::stat_stepribbon(alpha = 0.2)
+
+
+