ggalluvial (version 0.5.0)

geom_alluvium: Alluvia across strata

Description

geom_alluvium receives a dataset of the horizontal (x) and vertical (y, ymin, ymax) positions of the lodes of an alluvial diagram, the intersections of the alluvia with the strata. It plots both the lodes themselves, using geom_lode, and the flows between them, using geom_flow.

Usage

geom_alluvium(mapping = NULL, data = NULL, stat = "alluvium",
  position = "identity", width = 1/3, axis_width = NULL, knot.pos = 1/6,
  ribbon_bend = NULL, na.rm = FALSE, show.legend = NA,
  inherit.aes = TRUE, ...)

Arguments

mapping

Set of aesthetic mappings created by aes or 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.

stat

The statistical transformation to use on the data; override the default.

position

Position adjustment, either as a string, or the result of a call to a position adjustment function.

width

Numeric; the width of each stratum, as a proportion of the distance between axes. Defaults to 1/3.

axis_width

Deprecated; alias for width.

knot.pos

The horizontal distance between a stratum (width/2 from its axis) and the knot of the x-spline, as a proportion of the separation between strata. Defaults to 1/6.

ribbon_bend

Deprecated; alias for knot.pos.

na.rm

Logical: if FALSE, the default, NA lodes are not included; if TRUE, NA lodes constitute a separate category, plotted in grey (regardless of the color scheme).

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.

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.

...

Additional arguments passed to layer.

Aesthetics

geom_alluvium understands the following aesthetics (required aesthetics are in bold):

• x

• y

• ymin

• ymax

• alpha

• colour

• fill

• linetype

• size

• group

group is used internally; arguments are ignored.

See Also

layer for additional arguments, and stat_stratum and geom_stratum for intra-axis boxes.

Examples

# NOT RUN {
# basic
ggplot(as.data.frame(Titanic),
       aes(weight = Freq,
           axis1 = Class, axis2 = Sex, axis3 = Age,
           fill = Survived)) +
  geom_alluvium() +
  scale_x_continuous(breaks = 1:3, labels = c("Class", "Sex", "Age"))

# time series bump chart
ggplot(alluvial::Refugees,
       aes(weight = refugees,
           x = year, alluvium = country,
           fill = country, colour = country)) +
  geom_alluvium(width = 1/4, alpha = 2/3, decreasing = FALSE)

# time series line plot of refugees data, sorted by country
ggplot(data = alluvial::Refugees,
       aes(x = year, weight = refugees, alluvium = country)) +
  geom_alluvium(aes(fill = country),
                colour = "black", decreasing = NA, width = 0, knot.pos = 0)
# }