Phase.plots: Plots of fishing and spawning biomass status

View source: R/Phase.plots.R

Phase.plotsR Documentation

Plots of fishing and spawning biomass status

Description

The function Phase.plots provides plots of fishing status versus spawning biomass status.

Usage

Phase.plots(
  x,
  DataName = deparse(substitute(x)),
  draft = TRUE,
  graphics.type = NULL,
  use.color = TRUE,
  start.drop = 0,
  end.drop = 0,
  year.pos = 1,
  from.zero = TRUE,
  legend.pos = NULL,
  Xaxis.F = TRUE,
  F.series = "F.full",
  B.series = "SSB",
  F.B.references = list("Fmsy", "msst")
)

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.

end.drop

Number of years at the end of data to be omitted from plots, as when a model includes a projection period.

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. A value of year.pos=0 turns off the text feature.

from.zero

When TRUE, the Y-axis of each plot starts at zero.

legend.pos

A text string compatible with the legend function of R. Defines the position of the legend (ex. "bottomright", "bottom", etc.). The default NULL places text on the plot itself.

Xaxis.F

When TRUE, F is plotted as the X axis, otherwise, B.

F.series

Character string specifying the name of the F metric to be plotted

B.series

Character string specifying the name of the B (or SSB) metric to be plotted

F.B.references

a list of two character-sting names, the first specifying the fishing reference point and the second the biomass reference point. Insert a value of NULL if reference points are not desired for plotting.

Value

Graphics

Author(s)

M Prager

E Williams

K Shertzer

R Cheshire

K Purcell

Examples


Phase.plots(gag)


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