% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/marginal_means.R
\name{summary.marginal_means.brma}
\alias{summary.marginal_means.brma}
\title{Summarize Estimated Marginal Means}
\usage{
\method{summary}{marginal_means.brma}(
  object,
  type = NULL,
  probs = c(0.025, 0.5, 0.975),
  logBF = FALSE,
  BF01 = FALSE,
  bf = NULL,
  output_measure = NULL,
  transform = NULL,
  ...
)
}
\arguments{
\item{object}{a \code{marginal_means.brma} object.}

\item{type}{for RoBMA product-space objects, whether to summarize
model-averaged (\code{"averaged"}) or conditional (\code{"conditional"})
marginal means. Defaults to \code{"averaged"} and is available only for
RoBMA marginal means.}

\item{probs}{quantiles of the posterior distribution to be displayed.
Defaults to \code{c(.025, .50, .975)}.}

\item{logBF}{whether to show inclusion Bayes factors on the log scale.
Defaults to \code{FALSE}.}

\item{BF01}{whether to show inverse inclusion Bayes factors. Defaults to
\code{FALSE}.}

\item{bf}{whether to show inclusion Bayes factors. Defaults to the setting
stored by \code{marginal_means()}.}

\item{output_measure}{effect-size measure for location/effect predictions.
Defaults to the fitted measure. Supported conversions are among \code{"SMD"},
\code{"COR"}, \code{"ZCOR"}, and \code{"OR"}; \code{"RR"}, \code{"HR"},
\code{"IRR"}, \code{"RD"}, and \code{"GEN"} can only be returned on their
fitted measure. Use \code{transform = "EXP"} for ratio-scale output from
log-scale measures.}

\item{transform}{optional display transformation. Currently \code{"EXP"}
exponentiates log-scale measures \code{"OR"}, \code{"RR"}, \code{"HR"},
and \code{"IRR"}.}

\item{...}{additional arguments (currently ignored).}
}
\value{
A \code{BayesTools_table} of class
\code{summary.marginal_means.brma}.
}
\description{
Summarizes estimated marginal means stored in a
\code{marginal_means.brma} object using
\code{BayesTools::marginal_estimates_table()}.
}
