Template for reproducible research
Makefile TeX R
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
analysis
.Rbuildignore
.gitignore
DESCRIPTION
Makefile
README.Rmd
README.md
r-research-compendium.Rproj

README.md

R-Research-Compendium

r-research-compendium is my template for producing reproducible research in R. It is based off of the ideas in rrrpkg, as well as other templates including:

How to use this package

The easiest way would be to fork this repository and clone it to your local computer. You can then add your data, analysis, tests, and write and compile rmarkdown documents into the format you need.

The package can also be installed in R using devtools

    install.packages("devtools")
    library("devtools")
    install_github("potterzot/r-research-compendium", build_vignettes=TRUE)
    library("r-research-compendium")

The package contains the basic structure for an R-based research project. To use it I copy the directory to a new directory, change the name, etc..., and reinitialize it in git.

The template includes a data directory that includes data used in the project, and a vignettes directory that includes the manuscript, tutorial, or other output document made public. Repeated-use R functions are stored in the R directory, and documentation is automatically generated and stored in man.