multiSA (version 0.1.0)

report: Generate markdown reports

Description

Generate a markdown report of model fits and estimates.

Usage

report(object, ...)
# S3 method for MSAassess
report(
  object,
  name,
  filename = "MSA",
  dir = tempdir(),
  open_file = TRUE,
  render_args = list(),
  ...
)

Value

report.MSAassess invisibly returns the output of rmarkdown::render(): character of the path of the rendered HTML markdown report.

Arguments

object

An object from MSA.

...

Additional arguments to render reports.

name

Optional character string for the model name to include in the report, e.g., model run number. Default uses substitute(object)

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().