% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bind_forest_models.R
\name{bind_forest_models}
\alias{bind_forest_models}
\title{Bind multiple model summaries for a grouped forest plot}
\usage{
bind_forest_models(models, model_labels = NULL, exponentiate = NULL, ...)
}
\arguments{
\item{models}{A non-empty list of fitted model objects supported by
\code{\link[=tidy_forest_model]{tidy_forest_model()}}.}

\item{model_labels}{Optional labels used to identify each model in the
forest plot. Defaults to list names when present, otherwise \code{"Model 1"},
\code{"Model 2"}, and so on.}

\item{exponentiate}{\code{NULL}, a single logical value, or one logical value per
model. \code{NULL} uses the canonical scale inferred by \code{\link[=tidy_forest_model]{tidy_forest_model()}}
for each model.}

\item{...}{Additional arguments passed to \code{\link[=tidy_forest_model]{tidy_forest_model()}}, such as
\code{conf.level}, \code{intercept}, \code{term_labels}, or \code{sort_terms}.}
}
\value{
A standardized forest-plot data frame with one row per model term
and a \code{group} column containing the model labels.
}
\description{
Tidies multiple fitted models and stacks their fixed-effect coefficient
tables into a single forest-plot data frame. The resulting data can be
passed directly to \code{\link[=ggforestplot]{ggforestplot()}}, where model labels are used as the
grouping variable for dodged, color-coded estimates.
}
\examples{
if (requireNamespace("broom", quietly = TRUE)) {
  fit1 <- lm(mpg ~ wt + hp, data = mtcars)
  fit2 <- lm(mpg ~ wt + qsec, data = mtcars)

  bound <- bind_forest_models(
    list(Base = fit1, Adjusted = fit2)
  )

  ggforestplot(bound)
}
}
