Skip to content

About

R package for network models of HIV and STI transmission: the engine version used in each published paper, by release tag

Topics

Resources

Stars

25 stars

Watchers

10 watching

Forks

Latest commit

 

History

482 Commits

Folders and files

Repository files navigation

EpiModelHIV

EpiModelHIV is an R package for simulating HIV and other sexually transmitted infections over dynamic sexual networks. It extends EpiModel, our general platform for network-based epidemic modeling, with modules for the populations, partnerships, behaviors, and prevention and care services in our HIV and STI research.

This repository holds the version of EpiModelHIV used in each of the published papers listed below, so that their results can be reproduced. Development happens in a private repository, and we add a snapshot here when a paper is published.

How this repository is organized

  • Each paper has a release with a tag, such as EDP-JAIDS. The tag points to the exact engine code behind the paper's results.
  • Most releases also have a branch with the same code. Apart from notes added to their READMEs, snapshot branches are frozen: they are not updated or merged.
  • Each paper's analysis code (network estimation, calibration, scenarios, and the tables and figures) is in its own project repository, linked in the table below.
  • The default branch, CombPrev, is the snapshot for Jenness et al., AIDS 2020. Installing without a tag gets that version, so always give the tag for the paper you need.

Reproducing a paper

  1. Find the paper in the table below and clone its analysis repository.

  2. If the analysis repository has an renv.lock file, restore the package versions used for the paper by running this in R from the project folder:

    install.packages("renv")
    renv::restore(exclude = "ARTnetData")

    This installs EpiModelHIV from the paper's release, along with the versions of EpiModel, the statnet packages, and the other R packages recorded in the lockfile. Use the R version listed in the table if you can.

  3. If there is no lockfile, install the engine by its tag:

    remotes::install_github("EpiModel/EpiModelHIV@<tag>")

    These snapshots were built for EpiModel 1.x and depend on EpiModelHPC, which is on GitHub only (EpiModel/EpiModelHPC). Current releases of EpiModel, EpiModelHPC, and tergmLite are unlikely to work with them, so install versions from around the paper's date.

ARTnetData, the data package for the ARTnet survey of men who have sex with men, is private. It is needed only to re-estimate the network models; see the ARTnet repository for how to request access.

Papers

Newest first. The last column gives the EpiModel and R versions recorded in the analysis repository's renv.lock, or, where there is no lockfile, the oldest EpiModel version the snapshot accepts.

Paper Topic Release Analysis code renv.lock
Chandra et al., J Acquir Immune Defic Syndr 2026 Event-driven PrEP EDP-JAIDS EventDrivenPrEP EpiModel 2.3.2, R 4.3.2
Le Guillou et al., J Infect Dis 2026 Low-barrier PrEP access and monitoring LowBarrier-JID offscript EpiModel 2.5.0, R 4.5.2
Chandra et al., Lancet Reg Health Am 2026 PrEP reinitiation, uptake, and persistence in Boston PrEPReinit-LRHA PrEP-Reinitiation EpiModel 2.5.0, R 4.4.2
Onwubiko et al., BMC Health Serv Res 2026 Mental health care in PrEP programs MentalHealth-BMCHSR StigmaDepressionHIV EpiModel 2.4.0, R 4.3.2
Onwubiko et al., Sex Transm Dis 2025 Partner services for people previously diagnosed with HIV PartServDx-STD PartnerServiceYr3 EpiModel 2.3.2, R 4.2.3
Jones et al., Sex Transm Dis 2023 HIV infections per gonorrhea or chlamydia infection GCCT-STD PAFGuidelines EpiModel 2.0.5, R 4.2.0
Jenness et al., Sex Transm Dis 2022 HIV partner services PartServ-STD CombPrevNet EpiModel 2.0.4, R 4.1.2
Jones et al., Sex Transm Dis 2022 Gonorrhea and chlamydia screening and HIV incidence GCCT-STD PAFGuidelines EpiModel 2.0.5, R 4.2.0
Wheatley et al., J Acquir Immune Defic Syndr 2022 Cost-effectiveness of PrEP interventions PrEPCEA-JAIDS PrEP-CEA none (EpiModel 1.7.0 or later)
Le Guillou et al., J Acquir Immune Defic Syndr 2021 PrEP and ART in San Francisco SFPrEP-JAIDS SFO_PrEP EpiModel 1.8.0, R 4.0.2
Jenness et al., AIDS 2021 Investment in the PrEP care cascade Optim-AIDS PrEP-Optimize EpiModel 1.7.5, R 4.0.3
Jenness et al., J Infect Dis 2021 COVID-19 sexual distancing and service interruptions SexDist-JID SexualDistancing EpiModel 1.8.0, R 4.0.2
Maloney et al., J Infect Dis 2021 Long-acting injectable and daily oral PrEP LAPREP-JID injectable-prep EpiModel 1.7.5, R 4.0.2
Jenness et al., AIDS 2020 Integrated HIV prevention and care for the Ending the HIV Epidemic goals EHE-AIDS CombPrev EpiModel 1.7.3, R 4.0.2
Weiss et al., Sex Transm Dis 2019 Expedited partner therapy ept EPT none (EpiModel 1.2.7 or later)
Weiss et al., Open Forum Infect Dis 2019 STI screening coverage and frequency STITest-OFID (replaces ofid1) stitestguidelines none (EpiModel 1.2.7 or later)
Jones et al., Sex Transm Dis 2019 Share of HIV infections attributable to gonorrhea and chlamydia paf1 sti_paf none (EpiModel 1.2.7 or later)
Jenness et al., Am J Epidemiol 2019 PrEP care gaps and racial disparities p4 PrEPdisparities none (EpiModel 1.2.7 or later)
Jenness et al., Clin Infect Dis 2017 Gonorrhea and chlamydia after PrEP p3 stiPrEP none (EpiModel 1.2.7 or later)
Jenness et al., PLoS One 2017 PrEP risk compensation p2 HIV-Risk-Comp none (EpiModel 1.2.7 or later)
Jenness et al., J Infect Dis 2016 CDC PrEP guidelines p1 PrEPGuidelines none (EpiModel 1.2.0 or later)

Other public branches

These branches from the University of Washington group support published papers but have no release, and they keep their full development history.

Branch Papers
Kenya-TM Hamilton et al., J Acquir Immune Defic Syndr 2022; Hamilton et al., Epidemics 2023
Hometest Hamilton et al., Epidemics 2021
campcl Hamilton et al., Am J Public Health 2018; Hamilton et al., PLoS One 2019; Hamilton et al., J Adolesc Health 2021; Katz et al., Sex Transm Dis 2021
MSM-race-disparities Goodreau et al., Lancet HIV 2017

The remaining branches (master, main, shamp, shamp_params, shamp_summary_stats, and stiratetest) and the tags croi2017 and p3LID are from earlier development and are not tied to a published paper.

About the model

EpiModelHIV simulates a population of individuals and their sexual partnerships over time. In most of the papers above, partnerships form and dissolve on separate main, casual, and one-time networks, using temporal exponential-family random graph models from statnet (Krivitsky and Handcock 2014). For the papers since 2020, these network models were estimated from the ARTnet survey. At each time step, modules for demography, sexual behavior, HIV and STI transmission, and the HIV prevention and care continuum (testing, antiretroviral therapy, and PrEP) act on the population and its networks. The modules differ across snapshots, so each paper's methods and appendix describe the version it used.

The EpiModel website has documentation, tutorials, and course materials for network-based epidemic modeling, including our SISMID course.

Citation

Please cite the paper whose results you are using. For the modeling framework, also cite:

Jenness SM, Goodreau SM, Morris M. EpiModel: An R Package for Mathematical Modeling of Infectious Disease over Networks. J Stat Softw. 2018; 84(8): 1-47. https://doi.org/10.18637/jss.v084.i08

Questions

Questions about a specific analysis are best sent to the paper's corresponding author. If a snapshot does not install as described here, please open an issue in this repository. For EpiModel itself, see the EpiModel repository.

License

GPL-3. See LICENSE.md.

About

R package for network models of HIV and STI transmission: the engine version used in each published paper, by release tag

Topics

Resources

Stars

25 stars

Watchers

10 watching

Forks

Releases

Packages

Contributors

Languages