% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/methods.R
\name{summary.npf_seir}
\alias{summary.npf_seir}
\title{Summary method for npf_seir}
\usage{
\method{summary}{npf_seir}(object, burn = 0L, ...)
}
\arguments{
\item{object}{An \code{npf_seir} object.}

\item{burn}{Integer. Number of initial steps to exclude from summaries.
Default 0.}

\item{...}{Ignored.}
}
\description{
Summarises posterior parameter estimates and the range of \eqn{R_t}.
}
\value{
A named list of class \code{"npf_seir_summary"} returned invisibly with
components:
\describe{
  \item{\code{theta}}{Named numeric vector of length 3 giving the weighted
    posterior mean of the OU hyperparameters
    \eqn{(\kappa, \sigma_\Psi, \mu_\Psi)} at the final time step.}
  \item{\code{ou}}{Named list with elements \code{alpha} and \code{tau},
    the exact discrete-time OU transition parameters derived from
    \code{theta}; see \code{\link{ou_params}}.}
}
The function is also called for its side effect of printing a formatted
summary to the console, including posterior parameter estimates and the
range of \eqn{R_t} over the retained time steps.
}
