ethical-citations

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

Overview

This project is dedicated to …

Data sources

This project uses the following databases:

Database	Usage	Reference	Link
…	…	…	link

A comprehensive description of all these databases is available here.

Workflow

The analysis pipeline follows these steps:

1. …

Content

This repository is structured as follow:

• DESCRIPTION: contains project metadata (authors, description, license, dependencies, etc.).

• make.R: main R script to set up and run the entire project. Open this file to follow the workflow step by step.

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

• data/: contains raw data used in this project. See the README for further information.

• figures/: contains the figures of the project. See the README for a complete description of the files.

• outputs/: contains the outputs of the project. See the README for a complete description of the files.

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 steps listed in the make.R might take time (several hours)

Citation

Please use the following 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

This project is a collaborative work among FRB-CESAB postdocs.

References

…