What is ramp.dts?
ramp.dts was made to simplify the task of building discrete time systems to model the transmission dynamics and control of malaria and other mosquito-borne pathogen transmission (MBPT) systems. ramp.dts supports patch-based models and micro-simulation: the dts stands for discrete-time systems and it is a companion to ramp.xde. It is a modular framework to build discrete time MBPT models. It uses R’s S3 object system to define a set of components and interfaces which can be filled by any specific model that implements the interface. These parts, along with certain invariants can be put together to define a full simulation model. Definitions for all these terms can be found in the documentation.
We hope it proves useful. Please visit the website to learn more.
Installation
remotes::install_github('dd-harp/ramp.dts')Alternatively you can install Micro-MoB directly from CRAN, but be aware that the CRAN version may not be the most recent version of the package:
install.packages('ramp.dts')Documentation
To start learning more about the software design, the problems it was designed to solve, and how to build new models in Micro-MoB, please read vignette("ramp.dts").
Next, vignette("bloodmeal") describes how the bloodmeal algorithm computes the distribution of bites using each component’s interface, allowing different models to be linked in a consistent framework.
We also have articles describing some well-known models of specific components of MBPT models that are implemented in Micro-MoB:
-
vignette("RM_mosquito"): read about an implementation of a flexible Ross-Macdonald model of adult mosquito dynamics.
The article vignette("Advanced") contains information on how to extend Micro-MoB by linking to it from a new package, and how to write new models that interact with the rest of the system. It also contains information on how to use the Plumber web API which is supported for some models in Micro-MoB.
Contributing
Thank you for your interest in Micro-MoB! If you have a bug to report, please open an issue on GitHub. If you would like to open a pull request or have further questions, please see our guide to contributing to the project at vignette("Contributing").
Code of Conduct
Please note that the Micro-MoB project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms. # ramp.dts
