modelComparisons.Characteristics.Surveys: Render a document of comparison plots of estimated survey...

In wStockhausen/rCompTCMs: Package to compare TCSAM02, rsimTCSAM, and TCSAM2013 model runs

Render a document of comparison plots of estimated survey characteristics from several models

Description

Function to render a document of comparison plots of estimated survey characteristics from several models.

Usage

modelComparisons.Characteristics.Surveys(
  models,
  fleets = "all",
  selYears = c(1975, 1982, 1988),
  avlYears = NULL,
  capYears = c(1975, 1982, 1988),
  mxy = 5,
  output_format = c("word_document", "pdf_document"),
  output_dir = getwd(),
  rmd = system.file("rmd/modelComparisons.EstimatedCharacteristics.Surveys.Rmd", package
    = "rCompTCMs"),
  docx_styles = system.file("rmd/StylesForRmdDocs.docx", package = "wtsUtilities"),
  pdf_styles = system.file("rmd/StylesForRmdPDFs.sty", package = "wtsUtilities"),
  clean = FALSE
)

Arguments

models	named list of model results (as resLst objects) to compare
fleets	vector of names of survey fleets to plot, or "all"
selYears	vector of years for which to plot selectivity functions ("all"=all years; NULL=don't plot)
avlYears	vector of years for which to plot availability functions ("all"=all years; NULL=don't plot)
capYears	vector of years for which to plot capture probability functions ("all"=all years; NULL=don't plot)
mxy	number of functions to plot per page, when plotting selectivity, availability, or capture probability functions
output_format	"word_document" or "pdf_document"
output_dir	path to folder to use for output
rmd	Rmd file to process (defalut="modelComparisons.Rmd")
docx_styles	full path to Word (docx) style template for Word documents
pdf_styles	full path to style template for pdf documents
clean	T/F to delete intermediate files
rmd_dir	folder enclosing rmd file

Details

The default resulting document title will be of the form "ModelComparisons.EstimatedCharacteristics.Surveys.mmm.ext", where "ext" is the appropriate file extension and "mmm" is a dash-separated string of model names.

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