caption_bayesqm: Dynamic figure caption for a bayesqm_fit

View source: R/caption.R

caption_bayesqmR Documentation

Dynamic figure caption for a bayesqm_fit

Description

Returns a human-readable caption string summarising the model configuration (K, N, J, family), the sampler (backend, chains, post-warmup draws), the interval probability, and convergence diagnostics (max Rhat, divergent transitions).

Usage

caption_bayesqm(fit, include_ref = TRUE, include_diag = TRUE)

Arguments

fit

A bayesqm_fit.

include_ref

Logical; append a brief package-attribution line.

include_diag

Logical; append the convergence-diagnostic line.

Value

A length-1 character string.

Examples

fit <- demo_fit(N = 6, J = 10, K = 2, Td = 50, seed = 1)
cat(caption_bayesqm(fit))


bayesqm documentation built on June 18, 2026, 1:07 a.m.