compendiumDemo

Research Compendium to demonstrate best practices for reproducible research.

Steps to create

This compendium was setup by creating a new GitHub repo on GitHub, cloning it by starting a new project from version control in RStudio, and running rcompendium::new_compendium(create_repo = FALSE, renv = TRUE)

Content

This repository is structured as follow:

• data/: contains all raw data required to perform analyses

• analyses/: contains R scripts to run each step of the workflow

• outputs/: contains all the results created during the workflow

• figures/: contains all the figures created during the workflow

• R/: contains R functions developed especially for this project

• man/: contains help files of R functions

• DESCRIPTION: contains project metadata (author, date, dependencies, etc.)

• make.R: main R script to run the entire project by calling each R script stored in the analyses/ folder

Usage

Clone the repository, open R/RStudio and run:

source("make.R")

Notes

• All required packages, listed in the DESCRIPTION file, will be installed (if necessary)
• All required packages and R functions will be loaded
• Some analyses listed in the make.R might take time