Skip to contents

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

Usage

diagnostic_summary(fit)

# S3 method for class 'ratiod_diagnostic_summary'
print(x, ...)

Arguments

fit

A ratiod_fit object.

x

A ratiod_diagnostic_summary object.

...

Ignored.

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

# \donttest{
sim <- sim_ratiod(n = 100, family = ratiod_poisson_gamma(), seed = 1)
fit <- tratio(y_num | y_denom ~ x1 + (1 | group), data = sim$data,
              family = ratiod_poisson_gamma(),
              control = list(iter = 1000, chains = 2, seed = 1))
diagnostic_summary(fit)
#> 
#> === tulpaRatio Diagnostic Summary ===
#> 
#> Backend: hmc 
#> Status: WARN
#> 
#> Divergent transitions: 0
#> E-BFMI: 0.812 (OK)
#> 
#> Parameters with Rhat > 1.01:
#>      parameter  rhat
#>  beta_denom[1] 1.044
#>    beta_num[1] 1.042
#>  beta_denom[2] 1.013
#>       sigma_re 1.013
#> 
#> Parameters with ESS < 400:
#>      parameter ess_bulk ess_tail
#>    beta_num[1]      128      149
#>  beta_denom[1]      130      147
#>       sigma_re      157      211
#>  beta_denom[2]      186      147
#>          shape      344      336
#> 
#> Recommendations:
#>   - Rhat > 1.01: Run more iterations or chains 
#>   - ESS < 400: Run more iterations or use thinning 
# }