modelComparisons.ModelFits.ZCs: Render a document of comparison plots for model fits to size...

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

Render a document of comparison plots for model fits to size composition data

Description

Function to render a document of comparison plots for model fits to size composition data.

Usage

modelComparisons.ModelFits.ZCs(
  models,
  type = c("All", "Surveys", "Fisheries"),
  fleets = "all",
  plot1stObs = TRUE,
  output_format = c("word_document", "pdf_document"),
  output_dir = getwd(),
  rmd = NULL,
  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
type	"All", "Surveys", "Fisheries" (indicating, but not determining, what types of size compositions will be included)
fleets	vector of fleet names to include (or "all" or NULL for all fleets)
plot1stObs	flag to plot observed data only from first model
output_format	"word_document" or "pdf_document"
output_dir	path to folder to use for output
rmd	Rmd file to process (defalut="modelComparisons.ModelFits.ZCs.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

Resulting document title will be of the form "ModelComparisons.ModelFits.ZCs.type.mmm.ext", where "type" is the parameter type, ext" is the appropriate file extension, and "mmm" is a dash-separated string of model names. The actual type of size compositions included is determined by the R Markdown file specified by rmd.

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