README.md

Project Template

This repository attempts to provide a standard template for any future analysis projects. It focuses heavily on reproducibility relying on docker, MRAN, and requirements.txt to ensure all code can be re-run on any system.

Adding python modules

All modules in the env/python/requirements.txt file are installed automatically. If you want a new module to be added you need to manual add it via pip then update the requirements.txt file so that it is picking up on subsequent builds. This can be done via:

docker-compose run py pip install requests
docker-compose freeze > ./env/python/requirements.txt

Adding R libarires

If additional R libraries are needed just edit the ./env/R/requirements.R file

TODOs



gowerc/projectTemplate documentation built on June 1, 2019, 6:06 p.m.