StockRec.plots: Stock-recruitment plots
In rcheshire/FishGraph: Visualizations for fishery stock-assessment.

StockRec.plots

R Documentation

Stock-recruitment plots

Description

The function StockRec.plots generates plots of stock vs. recruitment in linear and logarithmic scales.

Usage

StockRec.plots(
  x,
  DataName = deparse(substitute(x)),
  draft = TRUE,
  graphics.type = NULL,
  use.color = TRUE,
  start.drop = 0,
  units.ssb = x$info$units.ssb,
  units.rec = x$info$units.rec,
  rec.model = x$info$rec.model,
  draw.model = TRUE,
  draw.lowess = FALSE,
  draw.time = TRUE,
  year.pos = 1
)

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.
`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`
`start.drop`	Number of years at the start of the data to be omitted from plots, as when a model includes an initialization period.
`units.ssb`	A text string (e.g. `"tons"` or `"10^9 eggs"`) used in labeling plots of spawning stock.
`units.rec`	A text string (e.g. `"million fish"`) for labeling plots of recruitment
`rec.model`	Specifies the type of recruitment function to draw. Valid values are: `"BH", "BH-steep", "Ricker", "Ricker-steep", "Mean"`.
`draw.model`	If `TRUE`, a function curve is drawn on plots of stock and recruitment.
`draw.lowess`	If `TRUE`, a lowess smooth is drawn on plots of stock and recruitment.
`draw.time`	If `TRUE`, stock-recruitment points are connected to indicate progression of time.
`year.pos`	An integer (= 1, 2, 3, or 4) defining the position of text relative to points. The text indicates first and last years in the time series, and applies only if draw.time=TRUE. A value of year.pos=0 turns off the text feature.