Skip to contents

Create a sankey plot with financial data

Source: R/plot_sankey.R
plot_sankey.Rd

Create a sankey plot with financial data

Usage

plot_sankey(
  data,
  with_company = TRUE,
  benchmark = benchmarks(),
  mode = c("equal_weight", "worst_case", "best_case")
)

Arguments

data

A data frame like without_financial

with_company

Logical. If TRUE, will plot a node with the company name. If FALSE, will plot without the company name node.

benchmark

The mode of benchmark to plot. It can be one of "all", "unit" or "tilt_sector", "unit_tilt_sector", "isic_4digit" or "unit_isic_4digit". If nothing is chosen, "all" is the default mode.

mode

The mode to plot. It can be one of "equal_weight", "worst_case" or "best_case". If nothing is chosen, "equal_weight" is the default mode.

Value

A sankey plot of class ggalluvial.

Examples

# Plot with equal weight and with company name
plot_sankey(financial)


# Plot with best_case weight and benchmark "all".
plot_sankey(financial, benchmark = "all", mode = "best_case")