plot_projection_ts: Plot projection time series

View source: R/figures-projections.R

plot_projection_tsR Documentation

Plot projection time series

Description

Plot projection time series

Usage

plot_projection_ts(
  object,
  type = c("SSB", "FM", "Catch"),
  n_samples = 3,
  probs = c(0.1, 0.5),
  ribbon_colours = RColorBrewer::brewer.pal(8, "Blues")[c(2, 4, 8)],
  bbmsy_zones = c(0.4, 0.8),
  catch_reference = 1,
  clip_ylim = NULL,
  seed = 42,
  french = FALSE
)

Arguments

object

A MSEtool object of class mse that was created by running MSEtool::runMSE().

type

A character vector describing the element of ⁠mse@⁠ to plot. Each of these "types" will be included as a column in the final plot.

n_samples

The number of timeseries samples to illustrate.

probs

A numeric vector of the quantiles to plot as ribbons. Must be of length 2.

ribbon_colours

A character vector of length three giving the colours for the outer uncertainty ribbon, inner uncertainty ribbon, and median.

bbmsy_zones

A numeric vector of status zone lines to add to the B/Bmsy panel if it is present.

catch_reference

The number of years over which to calculate the average catch and show as a horizontal line in a plot of catch.

clip_ylim

An optional numeric value to set the upper ylim value. clip_ylim is multiplied by the highest median value across the panels. Useful if there are outlying timeseries that distort the y axis limits.

seed

The seed to set before drawing samples.

french

French?

Value

ggplot object

See Also

plot_main_projections() plot_scenario_BMSY()

Examples

plot_projection_ts(mse_example, type = "SSB")
plot_projection_ts(mse_example, type = c("SSB", "FM"))

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