plot_scenario_projections: Plot projections for various scenarios on the same panels

View source: R/figures-projections-scenarios.R

plot_scenario_projectionsR Documentation

Plot projections for various scenarios on the same panels

Description

Plot projections for various scenarios on the same panels

Usage

plot_scenario_projections(
  object_list,
  probs = 0.5,
  rel_widths = c(2, 1.2),
  palette = "Dark2",
  catch_breaks = NULL,
  catch_labels = NULL,
  catch_ylim = NULL,
  msy_ylim = c(0, 4.5),
  french = isTRUE(getOption("french"))
)

Arguments

object_list

A named list of MSE objects from MSEtool. Names become scenario names.

probs

The quantiles to plot as ribbons. This represents the tail probability.

rel_widths

A numeric vector of length 2 the controls the relative width of the SSB and F columns (first element of the numeric vector) and the catch column (second element of the numeric vector). Depending on the number of years in the projection on the size of the axis labels, you may need to tweak the second element of this vector to make all 3 columns the same width. Figured it out by trial and error.

palette

The name of an RColorBrewer colour palette.

catch_breaks

Optional y-axis tick locations for the catch column.

catch_labels

Optional y-axis tick labels for the catch column. Helpful for dealing with large numbers.

catch_ylim

An optional numeric factor of length two that represents the y axis limits for the catch panels.

msy_ylim

SSB and F column y limits.

french

French?

Value

A ggplot object

Examples

x <- list()
x[[1]] <- mse_example
x[[2]] <- mse_example
names(x) <- c("Scenario 1", "Scenario 2")
plot_scenario_projections(x)
plot_scenario_projections(mse_example)

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