Skip to contents

Produces lollipop charts, Lorenz concentration curves, and stacked bar charts from a climasus_burden object returned by sus_mod_burden().

Usage

sus_mod_plot_burden(
  x,
  type = c("lollipop", "lorenz", "stacked"),
  output_type = c("plot", "table", "all"),
  interactive = FALSE,
  base_size = 12L,
  save_plot = NULL,
  lang = c("pt", "en", "es"),
  verbose = FALSE
)

Arguments

x

A climasus_burden object produced by sus_mod_burden().

type

Character. Plot type: "lollipop" (default), "lorenz", or "stacked".

output_type

Character. "plot" (default), "table", or "all" (named list $plot, $table, $data).

interactive

Logical. TRUE converts the ggplot2 output to an interactive plotly widget. Default FALSE.

base_size

Numeric. ggplot2 base font size. Default 12.

save_plot

Character or NULL. File path to save the plot.

lang

Character. Language for labels: "pt" (default), "en", "es".

verbose

Logical. Print progress messages. Default FALSE.

Value

Depending on output_type:

  • "plot" -> a ggplot or plotly object.

  • "table" -> a tibble of the plotted data.

  • "all" -> a named list: $plot, $table, $data.

Plot types (type)

typeDescription
"lollipop"Ranked lollipop chart of city AN or excess burden (default)
"lorenz"Lorenz concentration curve showing burden inequality across cities
"stacked"Stacked heat/cold bar by city (only for AF input with component = "all")

Examples

if (FALSE) { # \dontrun{
burden <- sus_mod_burden(af_list, lang = "pt")

sus_mod_plot_burden(burden, type = "lollipop", lang = "pt")
sus_mod_plot_burden(burden, type = "lorenz",   lang = "en")
sus_mod_plot_burden(burden, type = "stacked",  lang = "es")
out <- sus_mod_plot_burden(burden, output_type = "all")
out$table
} # }