Docker image for R.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
LICENSE.md
README.md
requirements-python.txt

README.md

datascience-r

CircleCI

This image is created from the rocker/verse Docker image and contains popular R packages for data science. It also includes the Civis Python and R API clients.

Installation

Either build the Docker image locally

docker build -t datascience-r .

or download the image from DockerHub

docker pull civisanalytics/datascience-r:latest

The latest tag (Docker's default if you don't specify a tag) will give you the most recently-built version of the datascience-r image. You can replace the tag latest with a version number such as 1.0 to retrieve a reproducible environment.

Usage

To start a Docker container from the datascience-r image and interact with it from a bash prompt, use

docker run -i -t civisanalytics/datascience-r:latest /bin/bash

You can run commands via

docker run civisanalytics/datascience-r:latest Rscript -e "print('Hello World!')"

The image contains environment variables which allow you to find the current version. There are four environment variables defined:

VERSION
VERSION_MAJOR
VERSION_MINOR
VERSION_MICRO

VERSION contains the full version string, e.g. "1.0.3". VERSION_MAJOR, VERSION_MINOR, and VERSION_MICRO each contain a single integer.

Contributing

See CONTRIBUTING for information about contributing to this project.

If you make any changes, be sure to build a container to verify that it successfully completes:

docker build -t datascience-r:test .

and describe any changes in the change log.

Tag a Release

To integrate with Civis Platform, the following format for releases must be followed:

  1. Tag: vX.X.X (major.minor.micro).
  2. Title: vX.X.X

The 'Description' field is not used in Civis Platform integration, but by convention it should have the following format:

Description: [YYYY-MM-DD] followed by summary of changes.

For Maintainers

This repo has autobuild enabled. Any PR that is merged to master will be built as the latest tag on Dockerhub. Once the release is tagged, DockerHub will automatically build three identical containers, with labels "major", "major.minor", and "major.minor.micro".

License

BSD-3

See LICENSE.md for details.