Skip to contents

Generate a markdown report of model fits and estimates.

Usage

report(object, ...)

# S3 method for class 'MARSassess'
report(
  object,
  name,
  filename = "MARS",
  dir = tempdir(),
  open_file = TRUE,
  render_args = list(),
  ...
)

Arguments

object

An object from MARS.

...

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

Value

report.MARSassess returns a HTML markdown report.