report: Generate markdown reports

In salmonMSE: Management Strategy Evaluation for Salmon Species

Generate markdown reports

Description

Generate a markdown report for outcomes from a single operating model projection

Usage

## S4 method for signature 'SMSE'
report(
  object,
  name = object@Name,
  filename = "SMSE",
  dir = tempdir(),
  open_file = TRUE,
  render_args = list(),
  ...
)

Arguments

object	SMSE object
name	Character string for the model name to include in the report, e.g., model run number.
filename	Character string for the name of the markdown and HTML files.
dir	The directory in which the markdown and HTML files will be saved.
open_file	Logical, whether the HTML document is opened after it is rendered.
render_args	List of arguments to pass to rmarkdown::render().
...	Additional arguments (not used)

Value

Returns invisibly the output of rmarkdown::render(), typically the path of the output file

See Also

compare()

salmonMSE documentation built on Aug. 20, 2026, 5:09 p.m.