BVDOutbreakSize

Appearance

API overview ​

The code is a Julia package, BVDOutbreakSize, and the report pages are literate scripts that call it. This section documents what the package offers, grouped by the job each part does.

Public and internal ​

Everything the package exports is public and documented here. The exported surface is what the report pages, the fit registry and the scripts use, and it is what a reader should build on. The vector observation distributions are declared public without being exported, and are documented with the observation models. Anything else is an implementation detail, kept on the internals page, and may change without notice.

The groups ​

The groups follow the order in which a fit runs.

GroupWhat it covers
Data and constantsLoading and freezing the situation-report data, and the fixed quantities
Renewal and delaysThe renewal recursion, the delay convolutions and the growth-rate conversions
Priors and latent submodelsTuring submodels for the epidemiological and surveillance processes
Observation modelsOne submodel per reported data stream
Joint and single-stream modelsThe composers that assemble a fittable model
FittingRunning NUTS, initialising it, and the progress callbacks
Summaries and diagnosticsPosterior tables and sampler diagnostics
Forecasts, scoring and counterfactualsForecasting from the fitted model, scoring against what arrived, and the counterfactuals
PlottingEvery figure in the report

Full index ​