% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ild_recovery_metrics.R
\name{ild_recovery_metrics}
\alias{ild_recovery_metrics}
\title{Recovery metrics from simulation replications}
\usage{
ild_recovery_metrics(sim_results, truth, level = 0.95, converged_only = TRUE)
}
\arguments{
\item{sim_results}{A data frame or tibble with columns \code{estimate},
\code{std_error}, and \code{converged} (as in \code{ild_power(..., return_sims = TRUE)$sim_results}).}

\item{truth}{Known value of the estimand (e.g. \code{effect_size} in [ild_power()]).}

\item{level}{Nominal coverage level for Wald intervals (default \code{0.95}).}

\item{converged_only}{If \code{TRUE} (default), only rows with \code{converged == TRUE}
are used.}
}
\value{
A one-row \code{\link[tibble]{tibble}} with \code{truth}, \code{n} (rows used),
  \code{n_total} (rows in \code{sim_results} if \code{converged_only}), \code{mean_estimate},
  \code{bias}, \code{rmse}, \code{coverage}, \code{level}.
}
\description{
Summarizes **bias**, **RMSE**, and **nominal Wald interval coverage** for a known
coefficient using the per-replication table from [ild_power()] when
\code{return_sims = TRUE}. Purely descriptive; does not run new simulations.
}
\seealso{
[ild_power()]
}
