knitr::opts_chunk$set(collapse = TRUE, comment = "#>", fig.path = "man/figures/", out.width = "100%")
• Overview
• Features
• Content
• Installation
• Usage
• Citation
• Contributing
• Acknowledgments
• References
This research compendium... {{ DESCRIBE YOUR PROJECT }}
The main purpose of this compendium is to... {{ DESCRIBE THE MAIN FEATURES }}
This repository is structured as follow:
DESCRIPTION
:
contains project metadata (authors, date, dependencies, etc.)
make.R
:
main R script to run the entire project
R/
:
contains R functions developed especially for this project
{{ LIST ADDITIONAL FILES/FOLDER }}
To install this compendium:
git clone fork-url
(replace fork-url
by the URL of your fork).
Alternatively, open RStudio IDE
and create a New Project from Version Control.Launch the make.R
file with:
source("make.R")
Notes
DESCRIPTION
file will be installed (if necessary)make.R
might take timePlease use the following citation:
{{ ADD A CITATION }}
All types of contributions are encouraged and valued. For more information, check out our Contributor Guidelines.
Please note that this project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
{{ OPTIONAL SECTION }}
{{ OPTIONAL SECTION }}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.