% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/results_text.R
\name{model_results}
\alias{model_results}
\alias{model_results.smoothbp_fit}
\title{Report the results of a smoothbp_fit object}
\usage{
model_results(object, ...)

\method{model_results}{smoothbp_fit}(object, digits = 3, width = 80, ...)
}
\arguments{
\item{object}{A \code{smoothbp_fit} or \code{smoothbp_ss_fit} object.}

\item{...}{Unused.}

\item{digits}{Integer; decimal places for all numerical output (default \code{3}).}

\item{width}{Integer; line-wrap width for narrative text (default \code{80}).}
}
\value{
The full results report as a single character string (invisibly).
The text is also printed to the console via \code{cat()}.
}
\description{
Produces a human- and AI-readable results report, including a plain-English
narrative, the fitted model equation with posterior mean coefficients
substituted to 3 d.p., per-breakpoint summaries, the full parameter table,
and convergence diagnostics.  The output is entirely self-contained: no
package documentation or source code is needed to interpret it.
}
\details{
The function name \code{model_results()} is used rather than \code{results()} for
consistency with \code{\link{model_methods}()} and to avoid any namespace
conflict with results functions in other packages.

For models with covariates on any structural parameter, the substituted
equation shows the intercept-only (reference-level) value; the full set of
coefficients is listed in the \strong{PARAMETER ESTIMATES} section.
}
\examples{
\dontrun{
fit <- smoothbp(y ~ tau, b0 = ~ 1 + (1 | subject), data = dat,
                chains = 4L, iter = 2000L, warmup = 1000L, seed = 42L)
model_results(fit)
txt <- model_results(fit)
}

}
