Skip to contents

Provides a comprehensive diagnostic report for a ratio model, combining convergence metrics, divergence information, and actionable recommendations.

Usage

diagnostic_summary(fit, quiet = FALSE)

Arguments

fit

A ratiod_fit object.

quiet

Logical; if TRUE, suppress printed output (default: FALSE).

Value

A list with class ratiod_diagnostic_summary containing:

status

Overall status: "PASS", "WARN", or "FAIL"

n_divergent

Number of divergent transitions

divergent_pct

Percentage of divergent transitions

worst_rhat

Data frame of parameters with worst Rhat

worst_ess

Data frame of parameters with worst ESS

e_bfmi

E-BFMI value (HMC only)

recommendations

Character vector of recommendations

Examples

# See plot_rhat() examples for fitting a model
# ds <- diagnostic_summary(fit)
# print(ds)