plot_tigure: Summary of performance metrics from MSE objects in a coloured...

In pbs-assess/ggmse: Tools for Working with openMSE (Including DLMtool, MSEtool, and SAMtool)

Summary of performance metrics from MSE objects in a coloured tile table format

Description

Summary of performance metrics from MSE objects in a coloured tile table format

Usage

plot_tigure(
  probs_dat,
  digits = 2,
  relative_max = FALSE,
  scale_0_1 = FALSE,
  sort_by = "decreasing",
  mp_order = NULL,
  satisficed = NULL,
  return_data = FALSE,
  alpha = 0.6,
  do_approx = TRUE,
  french = isTRUE(getOption("french"))
)

plot_tigure_facet(pm_df_list, ncol = NULL, ...)

Arguments

probs_dat	A data frame as returned from get_probs().
digits	How many decimal places to show in the tiles for the values
relative_max	Make the plot have each column use a relative maximum. If scale_0_1 is used, this will be ignored
scale_0_1	Scale each column from 0 to 1, so that the colours in each column are fully represented
sort_by	show values in decreasing or increasing format
mp_order	Optional hardcoded MP order
satisficed	An optional named numeric vector. The names correspond to the performance metrics and the values correspond to the values above which (>) the cells will be outlined as "satisficed".
return_data	Logical. If TRUE then the underlying data frame is returned instead of the plot.
alpha	Transparency of underlying colour.
do_approx	Logical. If TRUE, values greater than 0.99 are replaced with ">0.99" and less than 0.01 are replaced "<0.01".
french	French?
pm_df_list	A named list of performance metric data frames from get_probs(). The names will be used as the plot labels.
ncol	Optional number of columns.
...	Other arguments to pass to plot_tigure().

Examples

probs <- get_probs(mse_example, "P40", "P100", "PNOF", "LTY", "AAVY")
plot_tigure(probs)
plot_tigure(probs, alpha = 0.9)
plot_tigure(probs, satisficed = c("P40" = 0.9, "LTY" = 0.9))
probs <- get_probs(mse_example, "P40", "P100", "PNOF", "LTY", "AAVY")
pm <- list()
pm[[1]] <- get_probs(mse_example, "P40", "P100", "PNOF", "LTY", "AAVY")
pm[[2]] <- get_probs(mse_example, "P40", "P100", "PNOF", "LTY", "AAVY")
names(pm) <- c("Scenario 1", "Scenario 2")
plot_tigure_facet(pm)

pbs-assess/ggmse documentation built on Nov. 21, 2023, 8:06 p.m.