Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stan-dev/cmdstanr
CmdStanR: the R interface to CmdStan
https://github.com/stan-dev/cmdstanr
bayes bayesian markov-chain-monte-carlo maximum-likelihood mcmc r-package stan variational-inference
Last synced: 5 days ago
JSON representation
CmdStanR: the R interface to CmdStan
- Host: GitHub
- URL: https://github.com/stan-dev/cmdstanr
- Owner: stan-dev
- License: other
- Created: 2019-10-01T19:03:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T13:40:56.000Z (5 months ago)
- Last Synced: 2024-10-29T14:21:56.571Z (3 months ago)
- Topics: bayes, bayesian, markov-chain-monte-carlo, maximum-likelihood, mcmc, r-package, stan, variational-inference
- Language: R
- Homepage: https://mc-stan.org/cmdstanr/
- Size: 26.8 MB
- Stars: 143
- Watchers: 17
- Forks: 63
- Open Issues: 86
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - stan-dev/cmdstanr - CmdStanR: the R interface to CmdStan (R)
README
# CmdStanR 
[](https://CRAN.R-project.org/package=cmdstanr)
[](https://github.com/stan-dev/cmdstanr/actions?workflow=Unit-tests)
[](https://app.codecov.io/gh/stan-dev/cmdstanr?branch=master)
### Overview
CmdStanR is a lightweight interface to [Stan](https://mc-stan.org) for R users
(see [CmdStanPy](https://github.com/stan-dev/cmdstanpy) for Python).
If you are new to CmdStanR we recommend starting with these vignettes:
* [_Getting started with CmdStanR_](https://mc-stan.org/cmdstanr/articles/cmdstanr.html)
* [_How does CmdStanR work?_](https://mc-stan.org/cmdstanr/articles/cmdstanr-internals.html)
### Goals
* A clean interface to Stan services so that CmdStanR can keep up with Stan
releases.
* R code that doesn't interface directly with C++, only calls compiled executables.
* Modularity: CmdStanR runs Stan's algorithms and lets downstream modules do the
analysis.
* Flexible [BSD-3 license](https://opensource.org/license/bsd-3-clause).
### Installation
#### Installing the R package
You can install the latest beta release of the **cmdstanr** R package with
```r
# we recommend running this in a fresh R session or restarting your current session
install.packages("cmdstanr", repos = c('https://stan-dev.r-universe.dev', getOption("repos")))
```
This does not install the vignettes, which take a long time to build, but they are always available
online at https://mc-stan.org/cmdstanr/articles/.
To instead install the latest development version of the package from GitHub use
```r
# install.packages("remotes")
remotes::install_github("stan-dev/cmdstanr")
```
#### Installing CmdStan
If you don't already have CmdStan installed then, in addition to installing the
R package, it is also necessary to install CmdStan using CmdStanR's
`install_cmdstan()` function. A suitable C++ toolchain is also required.
Instructions are provided in the [_Getting started with
CmdStanR_](https://mc-stan.org/cmdstanr/articles/cmdstanr.html) vignette.
### Contributing
There is a lot of work still to be done and we welcome contributions from
anyone! If you are interested in contributing please comment on an open issue or
open a new one if none are applicable.
### License
CmdStanR, like CmdStan and the core Stan C++ code, is licensed under the
following licenses:
- Code: BSD 3-clause (https://opensource.org/license/bsd-3-clause/)
- Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)