Skip to contents

Returns a named list of summary-kind descriptors. Each descriptor has: kind, title, expected_metrics (named list of type strings, informative not enforced), emitted_by (free text), consumed_by_packs (character).

Usage

bg_summary_vocabulary()

Value

Named list of summary-kind descriptors.

Details

Evidence coverage

Every summary kind a built-in workflow pack matches on is emitted by at least one shipped executor (or is documented as requiring a user executor). The table below maps the kinds packs most commonly ask for to the built-in node kind that produces them:

summary kindproduced by built-in kindnotes
hmc_diagnosticscmdstanr_fit / brms_fitHMC sampler diagnostics
prior_predictive_checkprior_fit / brms_prior_fitprior-predictive draws
posterior_predictive_checkppcobserved y + capped yrep draws
loo_diagnosticslooPSIS-LOO Pareto-k
loo_pit_calibrationloo_pitrandomized PIT + PIET severity
sbc_resultsbcESS-bounded ranks + valid bins
comparison_results / stacking_weightscomparemodel comparison
prior_specuser executorrecord the prior
projpred_selectionuser executoruse projpred
causal_* / pad_*user executorssupply causal/PAD evidence

A test (test-summary-vocabulary-coverage.R) asserts every literal summary_kinds = "<kind>" referenced by a pack source is present here. New summary kinds used by packs require a vocabulary entry that identifies a built-in or user executor as the source.