modelComparisons.Characteristics.Fisheries: Render a document of comparison plots of estimated fishery...

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

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

Description

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

Usage

modelComparisons.Characteristics.Fisheries(
  models,
  fleets = "all",
  selyears = "all",
  retyears = "all",
  output_format = c("word_document", "pdf_document"),
  output_dir = getwd(),
  rmd = system.file("rmd/modelComparisons.EstimatedCharacteristics.Fisheries.Rmd",
    package = "rCompTCMs"),
  docx_styles = system.file("rmd/StylesForRmdDocs.docx", package = "wtsUtilities"),
  pdf_styles = system.file("rmd/StylesForRmdPDFs.sty", package = "wtsUtilities"),
  verbose = FALSE,
  clean = FALSE
)

Arguments

models	named list of model results (as resLst objects) to compare
fleets	vector of fisheries to plot, or "all"
selyears	vector of years to show selectivity functions for, or 'all' to show all years
retyears	vector of years to show retention functions for, or 'all' to show all years
output_format	"word_document" or "pdf_document"
output_dir	path to folder to use for output
rmd	Rmd file to process (defalut=system.file("rmd/modelComparisons.EstimatedCharacteristics.Fisheries.Rmd",package="rCompTCMs"))
docx_styles	full path to Word (docx) style template for Word documents
pdf_styles	full path to style template for pdf documents
verbose	flag to print debugging info
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.Fisheries.mmm.ext", where "ext" is the appropriate file extension and "mmm" is a dash-separated string of model names.

wStockhausen/rCompTCMs documentation built on Aug. 27, 2024, 7:15 p.m.