Skip to contents

ess_summary() reports effective sample size diagnostics for posterior draws, optionally scaled by wall-clock time.

Usage

ess_summary(
  fit,
  params = NULL,
  per_chain = TRUE,
  wall_time = NULL,
  robust = TRUE,
  ...
)

Arguments

fit

A "mixgpd_fit" or "causalmixgpd_causal_fit" object.

params

Optional character vector of parameter names/patterns. If NULL, a fixed canonical set is auto-resolved.

per_chain

Logical; if TRUE, include per-chain ESS rows.

wall_time

Optional numeric total MCMC time in seconds. If NULL, uses fit$timing$mcmc when available.

robust

Logical; if TRUE, ignore missing parameters.

...

Unused.

Value

Object of class "mixgpd_ess_summary" with elements table, overall, and meta.

Details

This is a convergence and efficiency diagnostic, not a model summary. For causal fits the function evaluates each outcome arm separately and tags the rows accordingly.