A software package for graphical building and analysis of compartmental simulation models

Description

This R package provides functionality that lets the user build and analyze compartmental simulation models, implemented as ordinary differential equations, stochastic equivalents, or discrete time models.
All model building and analysis can be done without writing code. The user can export code for one of the model implementations for further customization.

Installation

I assume you have R installed. I also highly recommend RStudio, though it’s not required.

  1. NOT YET ON CRAN: Install the CRAN release in the usual way with install.packages('DSAIDE').
  2. The latest development version (potentially buggy) can be installed from github, using the devtools package. If you don’t have it, install the devtools package. The following commands will get you up and running:
install.packages('devtools')
devtools::install_github('ahgroup/modelbuilder')

Basic Use

After install (which you need to do only once), load the package by runing library('modelbuilder'). You should receive a short greeting. Now you can open the main menu by running modelbuilder(). From the main menu, you can load a model, export code for a model, build a new or modify an existing model, and analyze model dynamics ofr a loaded model.

See the “Get Started” section on the Github Pages Site for a basic and currently sparse introduction.

Note

AS OF RIGHT NOW, THE PACKAGE HAS BASIC FUNCTIONALITY, BUT HAS NOT BEEN PROPERLY TESTED AND DEBUGGED YET! This is a very early version of the package, only some features are already implemented.

Contributing to the package

The package is on GitHub and you can use the usual GitHub process to contribute updated, bug fixes, etc. If you don’t know how to do that or don’t have the time, you can also file an issue on GitHub and let me know what should be changed.

The package is built in a way that makes it (hopefully) easy for others to contribute simulation models for others to use. A formal structure for model sharing is forthcoming.

Acknowledgements

This R package is developed and maintained by Andreas Handel. A full list of contributors can be found here. The development of this package was partially supported by NIH grant U19AI117891 and a grant from the University of Georgia’s Center for Teaching and Learning.