General-Purpose MCMC and SMC Samplers and Tools for Bayesian Statistics
Clone or download

README.md

Project Status: Active – The project has reached a stable, usable state and is being actively developed. License: GPL v3 CRAN_Status_Badge minimal R version

BayesianTools

R package for performing Bayesian inference, including various MCMC and SMC sampling algorithms!

Getting BayesianTools

BayesianTools is on CRAN (see here). To install the latest CRAN release, type

install.packages("BayesianTools")

To get an overview about its functionality once the package is installed, run

library(BayesianTools)
?BayesianTools
vignette("BayesianTools", package="BayesianTools")

As for every R package, you can get the suggested citation via

citation("BayesianTools")

Installing the development version from GitHub

If you want to install our development version from GitHub, use

devtools::install_github(repo = "florianhartig/BayesianTools", subdir = "BayesianTools", dependencies = T, build_vignettes = T)

New developments will be done in extra branches and will be tested before merging in the developtment branch, so the developmet version should usually be usable (consider it in a beta stage), while feature branches should be considered alpha.

Status master development branch Build Status

Windows users: the package contains c++ code, so if you compile yourself, you need RTools installed.

Older releases

To install a specific (older) release, decide for the version number that you want to install in https://github.com/florianhartig/BayesianTools/releases (version numbering corresponds to CRAN, but there may be smaller releases that were not pushed to CRAN) and run, e.g.

devtools::install_github(repo = "florianhartig/BayesianTools", subdir = "BayesianTools", ref = "v0.0.10", dependencies = T, build_vignettes = T)

with v0.0.10 replaced by the appropriate version number.

Getting help

We highly welcome questions by users, so don't be shy - any questions, even if it feels "stupid", helps us to understand how we can improve the interface, documentation, or code of the package.

If you want to ask a question or report a bug, the most convenient way for us would be to provide a reproducible example via the GitHub issues

Acknowledgements

Work on this package was facilicated through meetings of Cost Action FP 1304 Profound.