Skip to content

Latest commit

 

History

History
74 lines (39 loc) · 9.31 KB

README.md

File metadata and controls

74 lines (39 loc) · 9.31 KB
Raw

CircleCI license Project Status: Active – The project has reached a stable, usable state and is being actively developed. DOI

Visit rocker-project.org for more about available Rocker images, configuration, and use.

Version-stable Rocker images

rocker

image description size metrics build status
r-ver Version-stable base R & src build tools
rstudio Adds rstudio
tidyverse Adds tidyverse & devtools
verse Adds tex & publishing-related packages

This repository provides alternate stack to r-base, rocker/rstudio, rocker/hadleyverse series, with an emphasis on reproducibility. Compared to those images, this stack:

  • builds on debian stable (debian:jessie for versions < 3.4.0, debian:stretch thereafter) release instead of debian:testing, so no more apt-get breaking when debian:testing repos are updated and you had to muck with -t unstable to get apt-get to work.
  • Further, this stack installs a fixed version of R itself from source, rather than whatever is already packaged for Debian (the r-base stack gets the latest R version as a binary from debian:unstable),
  • and it installs all R packages from a fixed snapshot of CRAN at a given date (MRAN repos).
  • provides images that are generally smaller than the r-base series

Users should include the version tag, e.g. rocker/verse:3.3.1 when reproduciblity is paramount, and use the default latest tag, e.g. rocker/verse for the most up-to-date R packages. All images still receive any Debian security patch updates. Note that any debian packages on these images (C libraries, compilers, etc) will likely be older/earlier versions than those found on the r-base image series.

NOTES

  • do not use apt-get install r-cran-* to install R packages on this stack. The requested R version and all R packages are installed from source in the version-stable stack. Installing R packages from apt (e.g. the r-cran-* packages) will install the version of R and versions of the packages that were built for the stable debian release (e.g. debian:stretch), giving you a second version of R and different packages. Please install R packages from source using the install.packages() R function (or the install2.r script), and use apt only to install necessary system libraries (e.g. libxml2). If you would prefer to install only the latest verions of packages from pre-built binaries using apt-get, consider using the r-base stack instead.

Version Tags

Using the R version tag will naturally lock the R version, and also lock the install date of any R packages on the image. For example, rocker/tidyverse:3.3.1 Docker image will always rebuild with R 3.3.1 and R packages installed from the 2016-10-31 MRAN snapshot, corresponding to the last day that version of R was the most recent release. Meanwhile rocker/tidyverse:latest will always have both the latest R version and latest versions of the R packages.

Version tags for major and minor releases, such as rocker/r-ver:3.4 or rocker/verse:3, are added to the newest available bugfix version. The rules from the previous paragraph on R package versions apply. For example, if the latest bugfix versions availalbe are 3.3.3 and 3.4.1, then rocker/{stack name}:3.3.3 will also be tagged rocker/{stack name}:3.3 and rocker/{stack name}:3.4.1 will also be tagged rocker/{stack name}:3.4 and rocker/{stack name}:3.

See VERSIONS.md for details

Images

The image rocker/r-ver is the functional equivalent of r-base, though slightly pared down. Currently r-ver has tags for all minor R versions back to 3.1.0 (as far back as MRAN snapshots of CRAN are avialable); see all tags. Users can attempt to build other versions from the r-ver Dockerfile by specifying --build-arg R_VERSION=<VERSION>, though this is unlikely to work with very old R versions. Likewise, all non-current images are automatically pinned to a MRAN snapshot of CRAN from the last day that version was current. Users can set a custom snapshot date for the r-ver images by using --build-arg BUILD_DATE=<DATE> when building that Dockerfile.

The image rocker/tidyverse is the functional equivalent of rocker/hadleyverse, minus the LaTeX part which is moved into a downstream rocker/verse in order to keep the tidyverse image more compact. Now that tidyverse is a thing, the term "hadleyverse" is on the way out.

The rocker/rstudio image builds with the latest version of RStudio by default. This can be customized by specifying the desired version in --build-arg RSTUDIO_VERSION=<VERSION> if building locally from its Dockerfile. Note that: rocker/rstudio:latest is the only image name in this stack that already existed. For consistency, rocker/rstudio:latest now builds on r-ver:latest instead of r-base:latest. This change may break downstream images, which should either build explicitly on the debian:testing stack by using the testing tag (rocker/rstudio:testing) or be patched to support this change.

RStudio and Runtime Options

See the RStudio README for documentation on setting passwords, sharing volumes, adding RStudio Shiny Server(TM), and other configuration.

Maintenance and Updates

These images are actively maintained. This means that while an effort is made to preserve the general function of these images over time, both these Dockerfiles and the resulting images are subject to some change over time. In particular:

  • Images are regularly re-built on Docker Hub whenever their base image changes, starting with changes to debian Docker image. This is the rough equivalent of running apt-get upgrade on debian, since all apt-get commands are re-run and will pull in the most current sources. This allows the images to receive security updates to any packages installed from the debian repositories, but will not in general change the versions of any software and is very unlikely to break anything.

  • The Dockerfiles themselves are subject to change, to improve performance, ease of use, readability, or other concerns raised in the issues. These changes should also not alter the general behavior of R or R packages on the image. These changes can be seen in the git history. The rocker-versioned repo will use its own semantic version tagging to indicate changes to this repository, with snapshots from these tags archived on Zenodo.

License

The Dockerfiles in this repository are licensed under the GPL 2 or later.

Trademarks

RStudio is a registered trademark of RStudio, Inc. The use of the trademarked term RStudio and the distribution of the RStudio binaries through the images hosted on hub.docker.com has been granted by explicit permission of RStudio. Please review RStudio's trademark use policy and address inquiries about further distribution or other questions to [email protected].