Model Overview | Disease natural history scenarios | Transmission scenarios with interventions | Presymptomatic transmission scenarios with interventions | Transmission in isolation | Model parameters | Further information
Package: ringbp 1.0.0
Joshua W. Lambert
ringbp: Simulate and Evaluate Targeted Interventions in Infectious Disease Outbreaks
Branching process simulation model of infectious disease transmission with flexible parameterisation of epidemiology and targeted interventions, including isolation, contact tracing and quarantine, to reduce transmission, together with functions to evaluate outbreak control. Introduced in Hellewell et al. (2020) <doi:10.1016/S2214-109X(20)30074-7>.
Authors:
ringbp_1.0.0.tar.gz
ringbp_1.0.0.zip(r-4.7)ringbp_1.0.0.zip(r-4.6)ringbp_1.0.0.zip(r-4.5)
ringbp_1.0.0.tgz(r-4.6-any)ringbp_1.0.0.tgz(r-4.5-any)
ringbp_1.0.0.tar.gz(r-4.7-any)ringbp_1.0.0.tar.gz(r-4.6-any)
ringbp_1.0.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
ringbp/json (API)
| # Install 'ringbp' in R: |
| install.packages('ringbp', repos = c('https://epiforecasts.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/epiforecasts/ringbp/issues
Pkgdown/docs site:https://epiforecasts.io
controlling-outbreakstransmission
Last updated from:24522892f7 (on v1.0.0). Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 133 | ||
| source / vignettes | OK | 306 | ||
| linux-release-x86_64 | OK | 145 | ||
| macos-release-arm64 | OK | 109 | ||
| macos-oldrel-arm64 | OK | 130 | ||
| windows-devel | OK | 86 | ||
| windows-release | OK | 85 | ||
| windows-oldrel | OK | 91 | ||
| wasm-release | OK | 153 |
Exports:delay_optsdetect_extinctevent_prob_optsextinct_probincubation_to_generation_timeintervention_optsoffspring_optsoutbreak_modeloutbreak_setupoutbreak_stepscenario_simsim_opts
Dependencies:backportscheckmatedata.tablelatticeMASSMatrixMatrixModelsmnormtnumDerivquantregsnSparseMsurvival
{ringbp} Model Description
Last update: 2026-06-15
Started: 2026-02-16
Getting started with {ringbp}
Introduction | Model overview | Specifying model components | Offspring distributions | Delay distributions | Event probabilities | Intervention options | Simulation controls | Running outbreak simulations | Visualising results | Summarising outcomes | Simplified COVID-19 contact tracing effectiveness analysis | Define epidemiological parameters | Run the simulation | {ringbp} Use Cases | References
Last update: 2026-06-15
Started: 2026-02-16
Scenario parameter sweep
Set up scenario parameter space | Parameter sweep across scenarios | Storing simulations with scenarios | Running scenarios in parallel
Last update: 2026-05-20
Started: 2025-06-18
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Create a list of delay distributions to run the 'ringbp' model | delay_opts |
| Create a list of event probabilities to run the 'ringbp' model | event_prob_opts |
| Outbreak extinction functions | detect_extinct extinction extinct_prob |
| Convert symptom onset times to generation times | incubation_to_generation_time |
| Create a list of intervention settings to run the 'ringbp' model | intervention_opts |
| Create a list of offspring distributions to run the 'ringbp' model | offspring_opts |
| Run a single instance of the branching process model | outbreak_model |
| Set up initial cases for branching process | outbreak_setup |
| Move forward one generation in the branching process | outbreak_step |
| Run a specified number of simulations with identical parameters | scenario_sim |
| Create a list of simulation control options for the 'ringbp' model | sim_opts |
