Home

Awesome

Reproducible Research Project Initialization

Research project initialization and organization following reproducible research guidelines.

Overview

project
|- doc/            # documentation for the study
|  +- paper/       # manuscript(s), whether generated or not
|
|- data            # raw and primary data, are not changed once created 
|  |- raw/         # raw data, will not be altered
|  +- clean/       # cleaned data, will not be altered once created
|
|- code/           # any programmatic code
|- results         # all output from workflows and analyses
|  |- figures/     # graphs, likely designated for manuscript figures
|  +- pictures/    # diagrams, images, and other non-graph graphics
|
|- scratch/        # temporary files that can be safely deleted or lost
|- README          # the top level description of content
|- study.Rmd       # executable Rmarkdown for this study, if applicable
|- Makefile        # executable Makefile for this study, if applicable
|- study.Rproj     # RStudio project for this study, if applicable
|- datapackage.json # metadata for the (input and output) data files 

How to use

To the extent possible under law, the author(s) of this template have dedicated all copyright and related and neighboring rights to it to the public domain worldwide under the CC0 Public Domain Dedication. The template and all other content in the rr-init repository is distributed without any warranty.

Key concepts and goals

See Noble 2009 for a full description of and argument for the principle template structure. Some concepts and goals that guided this work:

Acknowledgements

The initial file and directory structure of this project was developed by a group of participants in the Reproducible Science Curriculum Workshop, held at NESCent in December 2014. The structure is based on, and heavily follows the one proposed by Noble 2009, with a few but small modifications.