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

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

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

Description

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

Usage

modelComparisons.ModelFits.ZCsByYear.Surveys(
  models,
  fleets = "all",
  years = "all",
  plot1stObs = TRUE,
  nrow = 5,
  ncol = 4,
  useBars = TRUE,
  usePins = FALSE,
  usePinsAndPts = FALSE,
  useLines = TRUE,
  usePoints = TRUE,
  pinSize = 0.2,
  lineSize = 1,
  pointSize = 1,
  alpha = 0.5,
  stripText = ggplot2::element_text(),
  output_format = c("word_document", "pdf_document"),
  output_dir = getwd(),
  rmd = system.file("rmd/modelComparisons.ModelFits.ZCsByYear.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	names of fleets to include (or "all")
years	years to plot, as numerical vector (or "all" to plot all years)
plot1stObs	flag (T/F) to plot observations only from first case, or character vector cases cases from which to plot observations
nrow	number of rows per page for output plots
ncol	number of columns per page for output plots
useBars	flag to use bars for observations
usePins	flag to use pins for observations
usePinsAndPts	flag to add pts to observations when pins are used
useLines	flag to use lines for predictions
usePoints	flag to use points for predictions
pinSize	width of pin line
lineSize	prediction line size
pointSize	prediction point size
alpha	prediction transparency
stripText	ggplot2::element_text() object describing font and margin to use for panel strips
output_format	"word_document" or "pdf_document"
output_dir	path to folder to use for output
rmd	Rmd file to process (defalut="rmd/modelComparisons.ModelFits.ZCsByYear.Surveys.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.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 Aug. 27, 2024, 7:15 p.m.