A directory structure and example files for a reproducible research project.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
article
grant
presentation
project
.gitignore
Makefile
README.Rmd
README.md
templates.Rproj

README.md

ORCiD Licence

Last-changedate

templates

Author

Nicholas Potter (potterzot@gmail.com)

Contents

This is the github repository for templates used for research projects, articles, grant proposals, and presentations. The templates are heavily inspired by reproducible research templates such as rScience's rrrpkg, Carl Boettiger's research template, Ben Marwick's research compendium and Karl Broman's Make tutorial. The templates make use of makefiles and R markdown to try to emphasize:

  • reproducibility: the final outputs should be easily reproducible, ideally with a single make command, so any changes to data, text, or sources are captured by the final outputs.

  • version control: git provides a record of all changes to the output so that changes to data and text can be traced if necessary and revisions are easy. Version control also allows for semantic simplicity, since there is no longer a need to create multiple "final_a.pdf", "final_2.pdf", etc... type files.

Requirements

These templates should be fairly low-intensity in terms of requirements. Rstudio with rmarkdown installed, and make should be enough. Some of the actual R markdown templates may use additional R packages like rticles or lubridate.

How to use this repository

Ideally, initialize a new git respository and then copy the specific template files into the repository. If you don't want to use git, you can also just copy the files into your project directory.

Contributing

Contributions and ideas welcome! Ideas and suggestions can be submitted as issues. To make a code contribution, please for and then make a pull request.

Licenses

Code: MIT License, 2017, Nicholas A Potter