Generate markdown reports — report • salmonMSE

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

Usage

# S4 method for class '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)