BSR.time.plots: Biomass, spawner, and recruitmenet trajectories

View source: R/BSR.time.plots.R

BSR.time.plotsR Documentation

Biomass, spawner, and recruitmenet trajectories

Description

The function BSR.time.plots generates time-series plots of stock biomass, spawning stock (as biomass or egg production), and recruitment. Plots are made on absolute scales and also scaled to reference points. Plots may include reference lines at user-specified reference points.

Usage

BSR.time.plots(
  x,
  DataName = deparse(substitute(x)),
  draft = TRUE,
  start.drop = 0,
  graphics.type = NULL,
  use.color = TRUE,
  units.b = x$info$units.biomass,
  units.ssb = x$info$units.ssb,
  units.r = x$info$units.rec,
  legend.pos = "topright",
  from.zero = TRUE,
  BSR.references = list("Bmsy", "SSBmsy", "Rmsy")
)

Arguments

x

an R list with output from the assessment models.

DataName

string used in plot titles. Defaults to argument x.

draft

modifies plots for use in a report. When FALSE main titles are omitted.

start.drop

Number of years at the start of the data to be omitted from plots, as when a model includes an initialization period.

graphics.type

a vector of graphics file types to which graphics are saved. When NULL, no plots are saved.

use.color

plots are made in grayscale when FALSE

units.b

A text string (e.g. "tons" for labeling plots of stock biomass.

units.ssb

A text string for labeling plots of spawning-stock biomass.

units.r

a text string (e.g. "million fish") for labeling plots of recruitment

legend.pos

A text string compatible with the legend function of R. Defines the position of the legend (ex. "bottomright", "bottom", etc.)

from.zero

When TRUE, the Y-axis of each plot (except recruitment deviations) starts at zero.

BSR.references

A list of three character-string names to specify reference points to appear on BSR plots, in order of biomass, spawning biomass, and recruits. Input NULL for none, e.g., BSR.references=list(NULL,"SSBmsy", NULL).

Value

Graphics

Author(s)

M. Prager

E. Williams

K. Shertzer

R. Cheshire

K. Purcell

Examples


BSR.time.plots(gag)



rcheshire/FishGraph documentation built on Feb. 23, 2024, 11:27 a.m.