% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/define-s4-class.R
\name{report}
\alias{report}
\alias{report,MSAassess-method}
\alias{report.MSAassess}
\title{Generate markdown reports}
\usage{
report(object, ...)

\S4method{report}{MSAassess}(
  object,
  name,
  filename = "MSA",
  dir = tempdir(),
  open_file = TRUE,
  render_args = list(),
  ...
)
}
\arguments{
\item{object}{An object from MSA.}

\item{...}{Additional arguments to render reports.}

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

\item{filename}{Character string for the name of the markdown and HTML files.}

\item{dir}{The directory in which the markdown and HTML files will be saved.}

\item{open_file}{Logical, whether the HTML document is opened after it is rendered.}

\item{render_args}{List of arguments to pass to \code{\link[rmarkdown:render]{rmarkdown::render()}}.}
}
\value{
\code{report} generic for MSAassess invisibly returns the output of \code{\link[rmarkdown:render]{rmarkdown::render()}}: character of the path of the rendered HTML markdown report.
}
\description{
Generate a markdown report of model fits and estimates.
}
