Simulate Disease Outbreak Line List and Contacts Data
Overview
Tools to simulate realistic raw case data for an epidemic in the form of line lists and contacts using a branching process. Simulated outbreaks are parameterised with epidemiological parameters and can have age-structured populations, age-stratified hospitalisation and death risk and time-varying case fatality risk.
This minor version release contains a range of minor updates and accompanies the _simulist_ publication in the Journal of Open Source Software (JOSS).
New features
- The sampling of sex for line list and contacts data can now be weighted instead of assuming a uniform probability via
prob_maleinconfig(#255). - The
reporting_delayargument insim_linelist()andsim_outbreak()now supports<epiparameter>objects, matching the functionality of the other delay distribution arguments (#262). - A new line list events plot has been added to the
vis-linelist.Rmdvignette (#278).
Breaking changes
- None
Minor changes
- Added
dependabot(#258). - GitHub actions versions are updated (multiple PRs).
.lintris updated to include more linters (#279) and the# nolintflag syntax is fixed (#263).
Bug fixes
Show all changes in 0.7.0Hide the rest of the changes in 0.7.0
- None
Deprecated and defunct
- None
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-06-08
- ERROR12 OK, 1 ERROR2026-06-07
- OK12 OK2026-04-25
Show 1 earlier changeHide 1 earlier change
- NOTE11 OK, 3 NOTE2026-03-10
Documentation
- Help pages
- 21 (14 internal)includes a package overview page
- Examples that run
- 100%7 run in a plain check
- Exported functions with examples
- 100%
- Documented parameters
- 73%
- Return-value docs
- 100%
- Help pages citing references
- 0%
- Getting Started with {simulist HTML
- Age-stratified hospitalisation and death risks HTML
- Age-structured population HTML
- Design Principles for {simulist HTML
- Reporting delays and right-truncation of line list data HTML
- Time-varying case fatality risk HTML
- Visualising simulated data HTML
- Wrangling simulated outbreak data HTML
Downloads
Repository
- PRs merged (all time)
- 96%
- Median days to close, 50 most recently updated closed issues
- 11
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Forks over time
Releases over time
Issues over time
PRs over time
Commits over time
17 development-tooling and community-health practices detected across 9 families in the upstream repository
Checks run against github.com/epiverse-trace/simulist on 2026-10-18.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2026-09-07 · The repository has a site deploy workflow
pkgdown site last built 2026-03-02
Show all practicesHide 5 practices
Dependencies
Installing simulist adds 27 packages (13 with compiled code, 13 MB of source tarballs). Heaviest: data.table 5.7 MB, jsonlite 1.0 MB, vctrs 1.0 MB.
Code & Tests
People & History
Pick two releases to compare their code metrics.
- RR 4.6.0 released · 2026-04-24
- 0.7.0Latest
- 0.6.0
- RR 4.5.0 released · 2025-04-11
- 0.5.0
- 0.4.02025-01-10
- RR 4.4.0 released · 2024-04-24
Package metadata
- First published
- 2025-01-10
- Total releases
- 4 / 1 yrs
- License
- MIT + file LICENSE OSI
- Minimum R
- ≥ 4.2.0
- Download size
- 2.9 MB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("simulist")The package provides a citation file that builds its entry when R runs it. Run citation() to see it.
The repository also keeps a CITATION.cff.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-20, which the citation names so these numbers can be found later. More on citing and the projects behind them.