plot_main_projections: Make a standard projection plot with SSB, F, and catch

View source: R/figures-projections.R

plot_main_projectionsR Documentation

Make a standard projection plot with SSB, F, and catch

Description

This is a wrapper for plot_projection_ts() that includes columns for SSB, F, and catch.

Usage

plot_main_projections(
  object,
  catch_breaks = NULL,
  catch_labels = NULL,
  rel_widths = c(2, 1.18),
  msy_ylim = c(0, 4.5),
  catch_ylim = NULL,
  french = isTRUE(getOption("french"))
)

Arguments

object

An MSE object from MSEtool.

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.

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.

msy_ylim

SSB and F column y limits.

catch_ylim

Catch column y limits.

french

French?

Value

A ggplot2 object

See Also

plot_projection_ts()

Examples

catch_breaks <- c(0, 1000, 2000, 3000)
plot_main_projections(mse_example,
  catch_breaks = catch_breaks,
  catch_labels = catch_breaks / 1000
)

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