% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/causalsim_eval.R
\name{summary.causalsim_eval}
\alias{summary.causalsim_eval}
\title{Summarise a causalsim_eval result}
\usage{
\method{summary}{causalsim_eval}(object, ...)
}
\arguments{
\item{object}{A \code{causalsim_eval} object.}

\item{...}{Ignored.}
}
\value{
An S3 object of class \code{causalsim_eval_summary} with components:
\describe{
\item{\code{metrics}}{The metrics data frame from the original result.}
\item{\code{mean_estimate}}{Mean of per-replication estimates.}
\item{\code{sd_estimate}}{Standard deviation of per-replication estimates.}
\item{\code{median_estimate}}{Median of per-replication estimates.}
\item{\code{p10_estimate}}{10th percentile of per-replication estimates.}
\item{\code{p90_estimate}}{90th percentile of per-replication estimates.}
\item{\code{true_ate}}{True ATE from the DGP.}
\item{\code{reps}}{Number of replications.}
}
}
\description{
Returns a structured summary of estimator performance including the metrics
table and the distribution of per-replication estimates (mean, SD, median,
and 10th / 90th percentiles).
}
