Research Compendium of the project {{ PLEASE ADD A FEW WORDS }}
Please cite this compendium as:
{{ PLEASE ADD A CITATION }}
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 theanalyses/
folder
Clone the repository, open R/RStudio and run:
source("make.R")
- 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