Overview
Experimental package for NeuroModulation Modeling in R. This package under active development and not ready for use.
Installation
Windows
If you are on Windows, you will first need ensure that RTools is installed and correctly setup.
Stan
nmmr relies on the CmdStanR interface to Stan. To install nmmr, first follow instructions for setting up Stan and cmdstanR. It is important that CmdStanR and CmdStan be installed before installing nmmr. Note that there are two steps to this process: 1) installing the R package CmdStanR, and 2) using this R package to install CmdStan.
The nmmr package
After installing CmdStanR, and CmdStan, nmmr can be installed with the remotes package.
# If you don't have the remotes package, install it with
# install.packages("remotes")
# then, run the following to install nmmr
remotes::install_github("psadil/nmmr")Next Steps
NeuroModulation Modeling comprises two kinds of analyses, a rough-and-ready check and a Bayesian model. The functions for performing these analyses are detailed in the following vignettes.
- Rough-and-ready non-parametric check. A Bayesian implementation of this analysis is also available, here.
- Full Bayesian Analysis
Code of Conduct
Please note that the nmmr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
