In FRBCesab/rcompendium: Create a Package or Research Compendium Structure

knitr::opts_chunk$set(collapse  = TRUE,
                      comment   = "#>",
                      fig.path  = "figures/readme/",
                      out.width = "100%")

{{project_name}}

• Overview
• Data sources
• Workflow
• Content
• Installation
• Usage
• Citation
• Contributing
• Acknowledgments
• References

Overview

This project is dedicated to... {{ DESCRIBE YOUR PROJECT }}

Data sources

This project uses the following databases:

{{ DESCRIBE THE DATA SOURCES }}

Workflow

The analysis pipeline follows these steps:

{{ DESCRIBE THE PIPELINE }}

Content

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 }}

Installation

To install this compendium:

• Fork this repository using the GitHub interface.
• Clone your fork using 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.

Usage

Launch the make.R file with:

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

Citation

Please use the following citation:

{{ ADD A CITATION }}

Contributing

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.

Acknowledgments

{{ OPTIONAL SECTION }}

References

{{ OPTIONAL SECTION }}

FRBCesab/rcompendium documentation built on Nov. 15, 2024, 9:38 p.m.