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

View source: R/modelComparisons.ModelFits.ZCsByYear.R

modelComparisons.ModelFits.ZCsByYearR Documentation

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

Description

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

Usage

modelComparisons.ModelFits.ZCsByYear(
  models,
  plot1stObs = TRUE,
  output_format = c("word_document", "pdf_document"),
  output_dir = getwd(),
  rmd = system.file("rmd/modelComparisons.ModelFits.ZCsByYear.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

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.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.ZCsByYear.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.