compareResults.Fisheries.RetFcns: Function to compare fishery retention functions by year among...

View source: R/compareResults.Fisheries.RetFcns.R

compareResults.Fisheries.RetFcnsR Documentation

Function to compare fishery retention functions by year among several models

Description

This function compares fishery retention functions by year among several models.

Usage

compareResults.Fisheries.RetFcns(
  objs,
  cast = "y+x",
  fleets = "all",
  years = "all",
  dodge = 0.2,
  mxy = 15,
  singlePlot = FALSE,
  facet_wrap = NULL,
  facet_grid = ifelse(singlePlot, "x~case", "y~x"),
  colour_scale = NULL,
  fill_scale = NULL,
  showPlot = FALSE,
  pdf = NULL,
  verbose = FALSE
)

Arguments

objs
  • list of resLst objects

cast
  • formula to exclude factors from "averaging" over

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

years
  • vector of years to show, or 'all' to show all years

dodge
  • width to dodge overlapping series

mxy
  • max number of years per page

singlePlot
  • flag to plot all years on single plot (be sure to adjust facet_grid)

facet_wrap
  • ggplot2 formula to produce figure with wrapped facets

facet_grid
  • ggplot2 formula to produce figure with gridded facets

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

None.

Value

lists of ggplot2 objects, nested by fishery or an empty list if year is NULL


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