compareResults.Pop.Biomass1: Function to compare population biomass estimates by year...

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

compareResults.Pop.Biomass1R Documentation

Function to compare population biomass estimates by year among several models

Description

This function compares biomass estimates (aggregated or as size comps, depending on "type") by year among several models.

Usage

compareResults.Pop.Biomass1(
  objs,
  type = c("B_yxmsz", "B_yxmz", "B_yxz", "B_yxms", "B_yxm", "B_yx"),
  years = "all",
  numRecent = 15,
  facet_grid = NULL,
  facet_wrap = NULL,
  scales = "fixed",
  dodge = 0.2,
  mxy = 15,
  nrow = 5,
  plotPoints = TRUE,
  colour_scale = NULL,
  fill_scale = NULL,
  showPlot = FALSE,
  pdf = NULL,
  verbose = FALSE
)

Arguments

objs
  • list of resLst objects

type
  • type of biomass ("B_yxmsz","B_yxmz","B_yxz","B_yxms","B_yxm","B_yx")

years
  • "all" or numerical vector of years to include

numRecent
  • number of "recent" years to plot

facet_grid
  • formula for faceting using facet_grid

facet_wrap
  • formula for faceting using facet_wrap

scales
  • ggplot2 scales option for 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

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

This function compares biomass estimates (aggregated or as size comps, depending on "type") by year among several models. It uses rTCSAM2013::getMDFR.Pop.Quantities, rsimTCSAM::getMDFR.Pop.Quantities, and to extract model results, and rTCSAM02::getMDFR.Pop.Quantities, and plotMDFR.XY to plot them. The level of aggregation is based on the value for "type" (unlike compreResults.Pop.Biomass, where a cast'ing formula is specified.)

Value

ggplot2 object


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