plot_convergence: Plot convergence

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

Plot convergence

Description

This function plots cumulative performance metric values across iterations to assess convergence.

Usage

plot_convergence(
  object_list,
  pm_list = c("LTY", "PNOF"),
  label_gap = 1.15,
  custom_pal = NULL,
  ylim = c(min(df$value), 1),
  satisficed = NULL,
  french = isTRUE(getOption("french"))
)

Arguments

object_list	A (named) list of MSEtool MSE objects.
pm_list	A list or vector of performance metrics as character.
label_gap	Controls the gap on the right of each panel to make space for the MP labels. This value is multiplied by the maximum number of iterations to expand the x axis.
custom_pal	An optional custom color palette. Should be a named character vector
ylim	Y limits. Defaults to the minimum observed performance metric value (via lazy evaluation) and 1.
satisficed	An optional named numeric vector. The names correspond to the performance metrics and the values correspond to the threshold. This will add a horizontal line on the relevant panels.
french	French?

Value

A ggplot2 plot.

Examples

plot_convergence(mse_example)
plot_convergence(mse_example, satisficed = c("LTY" = 0.9))

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