plot_class_waterfall: plot_class_waterfall
In JGCRI/rchart: Simple Customizable Charting

View source: R/plot_class_waterfall.R

plot_class_waterfall

R Documentation

plot_class_waterfall

Description

generate chart plot for absolute difference and percent difference

Usage

plot_class_waterfall(
  data_diff = NULL,
  data_agg = NULL,
  scenRef = NULL,
  scenDiff = NULL,
  theme = NULL,
  theme_default = ggplot2::theme_bw(),
  diff_text = NULL,
  scales = "free",
  diff_type = "bar",
  size = 1.5,
  break_interval = NULL,
  include_points = FALSE,
  summary_line = FALSE,
  wf_x = NULL,
  rect_width = 0.7,
  horizontal_lines = TRUE,
  lty = 2,
  fill_colors = NULL,
  totals_fill_color = "gray90",
  palette = NULL,
  vertical_dim = NULL,
  ylim = NULL,
  single_chart = F,
  scen_order = NULL
)

Arguments

`data_diff`	Default = NULL.
`data_agg`	Default = NULL.
`scenRef`	Default = NULL.
`scenDiff`	Default = NULL.
`theme`	Default = NULL
`theme_default`	Default = ggplot2::theme_bw(). Default rchart themes.
`diff_text`	Default = NULL. Text to remove from diff scenario names.
`scales`	Default = "free". Choose between "free", "free_y", "free_x", "fixed"
`diff_type`	Default = "bar". Choose between "bar" or "line"
`size`	Default = 1.5. Line size
`break_interval`	Default = NULL. Intervals between x breaks starting from first x point.
`include_points`	Default = FALSE. Add data points to all line charts.
`summary_line`	Default = FALSE. Add parameter summary line to all bar charts.
`wf_x`	Default = NULL. Year (or x value) for which to make the waterfall plot.
`rect_width`	Default = 0.7. Width of the rectangles in the waterfall plot.
`horizontal_lines`	Default = TRUE. Whether to include horizontal lines between rectangles
`lty`	Default = 2. Line type for the horizontal lines between rectangles
`fill_colors`	Default = NULL. Vector of colors for rectangles. If not specified, uses jgcricolors corresponding to classes
`totals_fill_color`	Default = "gray90". Color of the param total bars for the ref and diff scenarios
`palette`	Default = NULL. Named vector with custom palette colors (can include classes, regions, and/or scenarios; class colors will be used if provided)
`vertical_dim`	Default = NULL. Column to use for vertical stacking within classes
`ylim`	Default = NULL. Y-axis limits
`single_chart`	Default = F. If there are multiple diff scenarios, include them all in the same chart?
`scen_order`	Default = F. Order of scenarios to chart if single chart option is selected