A frozen version of the viral-predped repository. It provides a simulation function that combines the Minds for Mobile Agents pedestrian model (through the package predped) with a Quantifying Viruses in Environments viral disease spread model (through the package QVEmod).
To install the package, you can use the remotes package:
remotes::install_github("ndpvh/beprepared")
To use the package, use library
library(beprepared)
Note that the package may not load automatically, stating that it cannot find the Python module module. One known fix is to first load the package reticulate before loading beprepared:
library(reticulate)
library(beprepared)
This package allows users to simulate realistic viral disease spread patterns in realistic situations such as the supermarket, a bar, or a train station. For a detailed explanation on how to use the package, we refer the reader to the Documentation. In the documentation, one can find the background of the two models that make up the package and a detailed example. Additionally, one can find a detailed step-by-step guide on how to create environments and how to run simulations.
This version of beprepared is frozen in time and will not be developed anymore. To request a feature, we therefore ask to create an informative Issue on the sister repository viral-predped.
If you encounter a bug or need help getting a function to run, please file an issue with a minimal reproducible example on the sister repository on Github.
For more information on the M4MA project, please see its dedicated section on the lab website: https://www.ampl-psych.com/projects/minds-for-mobile-agents/. This work is part of the BePrepared consortium. More information on this consortium can be found on the following website: https://be-prepared-consortium.nl/
This project is distributed under a GNU GPL-3 license. For details, please see the License. Please note that the same licenses apply to the two packages that underlie beprepared.