Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Travis-CI Build Status

Motivation

magenta is an individual-based simulation model of malaria epidemiology and parasite genetics, which was designed to extends the Imperial malaria model by tracking the infection history of individuals. With this addition, genetic characteristics of the parasite can be assessed for looking at both neutral genetic variation as well as loci under selection.

The model is written in C++/Rcpp and interfaced with R, incorporating both the deterministic version of the Imperial College Transmission model developed by Joel Hellewell and Hannah Slater, which helps initialise the model near equilbrium. In addition it is used to quickly the mosquito feeding behaviour, which is passed to magenta in order to increase its speed.

Installation

You can also install rdhs from github with:

#install.packages("devtools")
devtools::install_github("OJWatson/rdhs")

Note that on Windows, a toolkit (Rtools) needs to be installed separately for devtools to work.

Once installed, the package can be loaded using:

# Load the package
library(magenta)

Documentation

magenta is documented on a dedicated website.

This includes the following vignettes:

  • Introduction: general introduction to the design of magenta and how to use it
  • Loggers: brief overview of the logging information returned by magenta
  • Resistance: (under development) description of how to simulate resistance