compareResults.Pop.Biomass: Function to compare estimated population biomass by year...

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

compareResults.Pop.BiomassR Documentation

Function to compare estimated population biomass by year among several models

Description

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

Usage

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

Arguments

objs
  • list of resLst objects

cast
  • casting formula for excluding x,m,s,z factor levels from sums across the unspecified factors

facet_grid
  • formula for faceting using facet_grid

facet_wrap
  • formula for faceting using facet_wrap

dodge
  • width to dodge overlapping series

years
  • 'all' or vector of years to include

mxy
  • max number of years per page

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

lnscale
  • use log scale on y axis

scales
  • scales parameter for facet_grid/facet_wrap

plotPoints
  • flag to include points

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. Results are extracted using rTCSAM2013::getMDFR.Pop.Biomass(), rsimTCSAM::getMDFR.Pop.Biomass(), and/or [rTCSAM02::getMDFR.Pop.Biomass()], as appropriate, and cast to aggregate. This differs from compareResults.Pop.Biomass1().

Value

ggplot2 object


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