compareResults.Surveys.Biomass: Function to compare estimated survey biomass by year among...

View source: R/compareResults.Surveys.Biomass.R

compareResults.Surveys.BiomassR Documentation

Function to compare estimated survey biomass by year among several models

Description

This function compares estimated survey biomass by year among several models.

Usage

compareResults.Surveys.Biomass(
  objs,
  fleets = "all",
  cast = "y+x",
  years = "all",
  facet_grid = "x~.",
  facet_wrap = NULL,
  scales = "fixed",
  dodge = 0.2,
  mxy = 15,
  nrow = 5,
  plotPoints = FALSE,
  colour_scale = NULL,
  fill_scale = NULL,
  showPlot = FALSE,
  pdf = NULL,
  verbose = FALSE
)

Arguments

objs
  • list of resLst objects

fleets
  • vector of fleets to plot, or "all"

cast
  • cast'ing formula for aggregating by factors (y,x,m,s,z)

years
  • 'all' or vector of years to include

facet_grid
  • formula for faceting using facet_grid

facet_wrap
  • formula for faceting using facet_wrap

scales
  • parameter passed to ggplot2::facet_grid()

dodge
  • width to dodge overlapping series

mxy
  • max number of years per page

nrow
  • number of rows per page, when facet_wrap'ing

plotPoints
  • flag to include points (default: FALSE)

colour_scale
  • ggplot2 colour scale to substitute for default (if not NULL)

fill_scale
  • ggplot2 fill scale to substitute for default (if not NULL)

showPlot
  • flag (T/F) to show plot

pdf
  • creates pdf, if not NULL

verbose
  • flag (T/F) to print diagnostic information

Details

If 'z' is a cast'ing factor, then a set of annual size composition plots are produced. Otherwise, a set of time series plots are produced.

Value

ggplot2 object


wStockhausen/rCompTCMs documentation built on Sept. 12, 2023, 3:13 p.m.