% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/interpret.R
\name{interpret}
\alias{interpret}
\alias{interpret.default}
\alias{interpret.brma}
\alias{print.interpret.brma}
\title{Interpret brma Results}
\usage{
interpret(object, ...)

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

\method{interpret}{brma}(
  object,
  output_measure = NULL,
  transform = NULL,
  conditional = FALSE,
  scope = "core",
  probs = c(0.025, 0.975),
  central = NULL,
  priors = FALSE,
  digits = 3,
  ...
)

\method{print}{interpret.brma}(x, ...)
}
\arguments{
\item{object}{a fitted model object.}

\item{...}{additional arguments passed to methods. The \code{brma} method
reserves \code{...}; unused arguments error, except deprecated
\code{output_scale}, which is accepted with a warning.}

\item{output_measure}{optional effect-size measure used for the pooled
effect only. Supported conversion targets include \code{"SMD"},
\code{"COR"}, \code{"ZCOR"}, and \code{"OR"} when the input scale allows
conversion.}

\item{transform}{optional display transformation. \code{"EXP"} exponentiates
log-scale \code{"OR"}, \code{"RR"}, \code{"HR"}, and \code{"IRR"}
pooled effects; aliases for no transform are accepted.}

\item{conditional}{whether to summarize conditional estimates for RoBMA
product-space objects. Defaults to \code{FALSE}.}

\item{scope}{character vector specifying sections to include. Use
\code{"core"} for the default concise interpretation, \code{"all"} for all
sections, or any of \code{"components"}, \code{"estimates"},
\code{"moderators"}, \code{"scale"}, and \code{"bias"}.}

\item{probs}{two quantiles used for credible intervals. Defaults to
\code{c(.025, .975)}.}

\item{central}{whether estimates are described by posterior mean or median.
Defaults to \code{NULL}, which uses the posterior mean, except for
\code{transform = "EXP"} pooled effects where the posterior mode is used.}

\item{priors}{whether to print prior distributions after the interpretation.
Defaults to \code{FALSE}.}

\item{digits}{number of digits after the decimal point.}

\item{x}{an \code{interpret.brma} object.}
}
\value{
A character vector with class \code{"interpret.brma"}. The
normalized BayesTools interpretation records are stored in the
\code{"records"} attribute; the \code{brma} method also stores
\code{"scope"}, \code{"conditional"}, and optionally \code{"priors"}.
}
\description{
Creates a concise textual interpretation of fitted RoBMA
\code{brma} objects.
}
