make_sankey: Create an object that describes a sankey plot

Description Usage Arguments Details Value

View source: R/make.R

Description

Create an object that describes a sankey plot

Usage

1
2
make_sankey(nodes = NULL, edges, y = c("optimal", "simple"),
  break_edges = FALSE, gravity = c("center", "top", "bottom"))

Arguments

nodes

A data frame of nodes on the plot, and possibly their visual style. The first column must be the ids of the nodes. If this argument is NULL, then the ids of the nodes are determined from edges.

edges

A data frame of the edges. The first two columns must be node ids, and they define the edges. The rest of the columns contain the visual style of the edges.

y

How to calculate vertical coordinates of nodes, if they are not given in the input. optimal tries to minimize edge crossings, simple simply packs nodes in the order they are given, from bottom to top.

break_edges

Whether to plot each edge as two segments, or a single one. Sometimes two segment plots look better.

gravity

Whether to push the nodes to the top, to the bottom or to the center, within a column.

Details

The node and edges data frames may contain columns that specify how the plot is created. All parameters have reasonable default values.

Current list of graphical parameters for nodes:

Current list of graphical parameters for edges:

Value

A sankey object that can be plotted via the sankey function.x


sankey documentation built on May 29, 2017, 9:56 p.m.

Search within the sankey package
Search all R packages, documentation and source code