A plot visualizing flow/movement/change from one state to another or one time to another.
AlluvialPlot is an alias of SankeyPlot.
Usage
SankeyPlot(
data,
y = NULL,
nodes_by,
nodes_color = "grey30",
links_by = NULL,
links_by_sep = "_",
links_name = NULL,
split_by = NULL,
split_by_sep = "_",
palette = "Paired",
palcolor = NULL,
alpha = 0.6,
nodes_label = FALSE,
x_text_angle = 0,
aspect.ratio = 1,
legend.position = "right",
legend.direction = "vertical",
legend.box = "vertical",
theme = "theme_this",
theme_args = list(),
title = NULL,
subtitle = NULL,
xlab = NULL,
ylab = NULL,
combine = TRUE,
nrow = NULL,
ncol = NULL,
byrow = TRUE,
seed = 8525,
...
)
AlluvialPlot(
data,
y = NULL,
nodes_by,
nodes_color = "grey30",
links_by = NULL,
links_by_sep = "_",
links_name = NULL,
split_by = NULL,
split_by_sep = "_",
palette = "Paired",
palcolor = NULL,
alpha = 0.6,
nodes_label = FALSE,
x_text_angle = 0,
aspect.ratio = 1,
legend.position = "right",
legend.direction = "vertical",
legend.box = "vertical",
theme = "theme_this",
theme_args = list(),
title = NULL,
subtitle = NULL,
xlab = NULL,
ylab = NULL,
combine = TRUE,
nrow = NULL,
ncol = NULL,
byrow = TRUE,
seed = 8525,
...
)Arguments
- data
A data frame.
- y
A character string specifying the column name of the data frame to plot for the y-axis.
- nodes_by
A character vector of column names to define the nodes.
- nodes_color
A character string to color the nodes.
- links_by
A character vector of column names to define the links. If NULL, the links_by will be the first column in nodes_by.
- links_by_sep
A character string to concatenate the columns in
links_by, if multiple columns are provided.- links_name
A character string to name the legend of links.
- split_by
The column(s) to split data by and plot separately.
- split_by_sep
The separator for multiple split_by columns. See
split_by- palette
A character string specifying the palette to use.
- palcolor
A character string specifying the color to use in the palette.
- alpha
A numeric value specifying the transparency of the plot.
- nodes_label
A logical value to show the labels on the nodes.
- x_text_angle
A numeric value specifying the angle of the x-axis text.
- aspect.ratio
A numeric value specifying the aspect ratio of the plot.
- legend.position
A character string specifying the position of the legend. if
waiver(), for single groups, the legend will be "none", otherwise "right".- legend.direction
A character string specifying the direction of the legend.
- legend.box
A character string to specify the box of the legend, either "vertical" or "horizontal".
- theme
A character string or a theme class (i.e. ggplot2::theme_classic) specifying the theme to use. Default is "theme_this".
- theme_args
A list of arguments to pass to the theme function.
- title
A character string specifying the title of the plot. A function can be used to generate the title based on the default title. This is useful when split_by is used and the title needs to be dynamic.
- subtitle
A character string specifying the subtitle of the plot.
- xlab
A character string specifying the x-axis label.
- ylab
A character string specifying the y-axis label.
- combine
Whether to combine the plots into one when facet is FALSE. Default is TRUE.
- nrow
A numeric value specifying the number of rows in the facet.
- ncol
A numeric value specifying the number of columns in the facet.
- byrow
A logical value indicating whether to fill the plots by row.
- seed
The random seed to use. Default is 8525.
- ...
Additional arguments.
Examples
set.seed(8525)
data <- data.frame(
nodes1 = sample(LETTERS[1:3], 10, replace = TRUE),
nodes2 = sample(letters[1:3], 10, replace = TRUE),
nodes3 = sample(LETTERS[4:6], 10, replace = TRUE),
y = sample(1:5, 10, replace = TRUE)
)
SankeyPlot(data, nodes_by = c("nodes1", "nodes2", "nodes3"))
SankeyPlot(data, nodes_by = c("nodes1", "nodes2", "nodes3"), nodes_label = TRUE)
SankeyPlot(data, nodes_by = c("nodes1", "nodes2", "nodes3"), links_by = "y")
SankeyPlot(data, nodes_by = c("nodes1", "nodes2", "nodes3"), y = "y")
