❗ This repository is deprecated and no longer updated (original) (raw)

r-packages

Stan’s R packages are now built and distributed by our R-Universe organisation: https://stan-dev.r-universe.dev/builds

For more information, see this forum announcement

Repository for distributing (some) stan-dev R packages

A place for publishing new versions of (some) stan-dev R packages before they reach CRAN and for stan-dev R packages and versions where releasing on CRAN is not a (current) goal. As of 2021-03-16 this is most relevant for rstan, where the CRAN version is unfortunately several releases behind and pushing a new version to CRAN has been difficult.

The packages currently hosted in this repository are:

cmdstanr
rstan
StanHeaders (required for rstan)
rstanarm (Survival branch - https://arxiv.org/pdf/2002.09633.pdf)

To install latest rstan or other packages from the repo, add https://mc-stan.org/r-packages/ to your repository list, e.g.:

install.packages("rstan", repos = c("https://mc-stan.org/r-packages/", getOption("repos")))

Using with `renv`

To make this repository work smoothly with the renv dependency management package, you need to setup the repository once per project (further installs will always consider this repository). You have two options to do this:

Add the repo as a named repository into your options via

repos <- c(Stan = "https://mc-stan.org/r-packages/", CRAN = "https://cloud.r-project.org")
options(repos = repos)

Now, install the packages you need and immediately run renv::snapshot().

Alternatively you can just add the repository directly into the renv.lock file, so you’ll have something like:

    "Repositories": [
      {
        "Name": "CRAN",
        "URL": "https://cran.rstudio.com"
      },
      {
        "Name": "Stan",
        "URL": "https://mc-stan.org/r-packages"
      }
    ]

You’ll need to restart the R session after this modification.

How to publish/update packages on this repository

For stan-dev/r-packages maintainers

Install the drat package
Clone this repository and make sure you are on the gh-pages branch (the default branch).

git clone https://github.com/stan-dev/r-packages  
git status

Create the package tarball (tar.gz) file
or

R CMD build packageFolder

Run drat to update the repository

drat::insertPackage("path/to/package_tarball.tar.gz", "path/to/r-packages/")

For example:

drat::insertPackage("cmdstanr_0.4.0.tar.gz", "r-packages/")

Commit and push changes to the stan-dev/r-packages repository.

For others that wish to publish their package on https://mc-stan.org/r-packages

Install the drat package
Fork this repository, clone your fork and make sure you are on the gh-pages branch (the default branch).

git clone https://github.com/yourusername/r-packages  
git status

Create the package tarball (tar.gz) file
or

R CMD build packageFolder

Run drat to update the repository

drat::insertPackage("path/to/package_tarball.tar.gz", "path/to/r-packages/")