% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/extract_param.R
\name{extract_param}
\alias{extract_param}
\title{Extract labelled parameter summaries from a fitted bvarnet model}
\usage{
extract_param(object, bayes_factor = FALSE, null_value = 0, type = NULL)
}
\arguments{
\item{object}{A \code{bvarnet} object returned by \code{bvar()}.}

\item{bayes_factor}{Logical; if \code{TRUE}, append \code{BF01} and
\code{BF10} columns computed via the Savage-Dickey density ratio for
beta and phi parameters.  Default \code{FALSE}.}

\item{null_value}{Numeric scalar; the null hypothesis value for Bayes
factor computation (default 0).  Only used when \code{bayes_factor = TRUE}.}

\item{type}{Character vector or \code{NULL} (default). If supplied, only
rows matching the given type(s) are returned.  Valid values are:
\code{"Intercept"}, \code{"Fixed Effect"}, \code{"Autoregressive"},
\code{"Cross-lagged"}, \code{"Random Effect SD"}, \code{"Residual SD"},
\code{"Threshold"}.}
}
\value{
A data frame with columns: \code{type}, \code{predictor},
\code{outcome}, \code{mean}, \code{median}, \code{q5}, \code{q95},
\code{rhat}, \code{ess_bulk}, \code{ess_tail}, and optionally
\code{BF01}, \code{BF10}.
}
\description{
Returns a single flat data frame with posterior summaries (mean, median,
5th/95th percentiles) and convergence diagnostics (Rhat, ESS) for all
model parameters.
}
