% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prior_summary.R
\name{prior_summary}
\alias{prior_summary}
\alias{prior_summary.default}
\alias{prior_summary.mlumr_fit}
\title{Summary of priors used by a fitted ML-UMR model}
\usage{
prior_summary(object, ...)

\method{prior_summary}{default}(object, ...)

\method{prior_summary}{mlumr_fit}(object, digits = 3, ...)
}
\arguments{
\item{object}{An \code{mlumr_fit} object.}

\item{...}{Unused.}

\item{digits}{Number of significant digits for numeric values (default 3).}
}
\value{
Invisibly returns a list describing the priors; the side effect is
printing a formatted summary.
}
\description{
Print a human-readable summary of every prior that was used to fit an
\code{\link[=mlumr]{mlumr()}} model, including the effective per-coefficient scales after
autoscaling. Mirrors the spirit of \code{rstanarm::prior_summary()}.
}
\examples{
\dontrun{
fit <- mlumr(dat)
prior_summary(fit)
}
}
\seealso{
\code{\link[=prior_sensitivity]{prior_sensitivity()}} to quantify how much the posterior moves
under alternative \code{prior_beta} scales; \code{\link[=prior_normal]{prior_normal()}},
\code{\link[=prior_student_t]{prior_student_t()}}, \code{\link[=prior_cauchy]{prior_cauchy()}}, \code{\link[=prior_exponential]{prior_exponential()}} for the
prior constructors themselves.
}
