Ten simple rules for Writing Dockerfiles for Reproducible Research

The manuscript is published as a preprint: https://osf.io/fsd7t

We welcome your feedback, e.g., by opening issues on this repository or with OSF annotations. We especially welcome you help by creating strong illustrating examples, see issue #4.

Ten Simple Rules Collection on PLOS

Current draft as PDF

First, build the container. It will install the dependencies that you need for compiling the LaTex.

docker build -t ten-simple-rules-dockerfiles .

Then run it! You'll need to set a password to login with user "rstudio."

PASSWORD=simple
docker run --rm -it -p 8787:8787 -e PASSWORD=$PASSWORD -v $(pwd):/home/rstudio/ten-simple-rules-dockerfiles ten-simple-rules-dockerfiles

Open http://localhost:8787 to get to RStudio, log in, and navigate to the directory ~/ten-simple-rules-dockerfiles to open the Rmd file and start editing. Use the "Knit" button to render the PDF. The first rendering takes a bit longer, because required LaTeX packages must be installed.

See more options in the Rocker docs.

See the end of the Dockerfile for instructions.

• Get all author's GitHub handles:

  cat *.Rmd | grep ' # https://github.com/' | sed 's|    # https://github.com/|@|'

• Get all author's emails:

  cat *.Rmd | grep 'email:' | sed 's|    email: ||'

This manuscript is published under a Creative Commons Attribution 4.0 International (CC BY 4.0) license, see file LICENSE.md.