% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/summary.estimate.R
\name{summary.estimate}
\alias{summary.estimate}
\title{Summary of estimate objects}
\usage{
\method{summary}{estimate}(
  object,
  contrast,
  ...,
  null = 0,
  level = 0.95,
  type,
  var.adj = 0.25,
  df,
  transform = NULL,
  print = NULL
)
}
\arguments{
\item{object}{an \code{estimate} object.}

\item{contrast}{(optional) contrast matrix for the final Wald test.}

\item{...}{additional arguments passed to \link{contr}.}

\item{null}{(optional) null hypothesis to test.}

\item{level}{level of confidence limits (default 0.95)}

\item{type}{type of small-sample correction. Requires the estimate to have
been computed with \code{IC=TRUE} (the default).}

\item{var.adj}{variance adjustment parameter for small-sample correction.
Requires the estimate to have been computed with \code{IC=TRUE} (the default).}

\item{df}{degrees of freedom for t-based inference (default: \code{NULL} for
Gaussian approximation; when set, confidence intervals and p-values use the
t-distribution with \code{df} degrees of freedom)}

\item{transform}{(optional) function applied to the point estimates and
confidence interval bounds \emph{after} inference is performed on the original
scale. Useful for variance-stabilizing transformations, e.g., compute CIs
on the \code{atanh} (Fisher z) scale and back-transform with \code{tanh}.}

\item{print}{(optional) custom print function for the resulting
\code{summary.estimate} object}
}
\description{
Computes hypothesis tests, contrasts, and small-sample corrections for
an \link{estimate} object. The arguments \code{null}, \code{contrast}, \code{type}, and
\code{var.adj} were previously available on \code{\link[=estimate.default]{estimate.default()}} and have
been moved here.
}
\seealso{
\code{\link[=estimate.default]{estimate.default()}}
}
