epiverseworkshop3

:package: The Title of the Project

https://github.com/scarabel/epiverseworkshop3

Repository

:package: The Title of the Project

README.Rmd

---
output: github_document
---




```{r, include = FALSE}
knitr::opts_chunk$set(collapse  = TRUE,
                      comment   = "#>",
                      fig.path  = "man/figures/",
                      out.width = "100%")
```



# epiverseworkshop3



[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)
[![Dependencies](https://img.shields.io/badge/dependencies-2/95-green?style=flat)](#)



Research Compendium of the project **{{ PLEASE ADD A FEW WORDS }}**



### How to cite

Please cite this compendium as: 

> **{{ PLEASE ADD A CITATION }}**



### Content

This repository is structured as follow:

- [`data/`](https://github.com/scarabel/epiverseworkshop3/tree/master/data):
contains all raw data required to perform analyses

- [`analyses/`](https://github.com/scarabel/epiverseworkshop3/tree/main/analyses/):
contains R scripts to run each step of the workflow

- [`outputs/`](https://github.com/scarabel/epiverseworkshop3/tree/main/outputs):
contains all the results created during the workflow

- [`figures/`](https://github.com/scarabel/epiverseworkshop3/tree/main/figures):
contains all the figures created during the workflow

- [`R/`](https://github.com/scarabel/epiverseworkshop3/tree/main/R):
contains R functions developed especially for this project

- [`man/`](https://github.com/scarabel/epiverseworkshop3/tree/main/man):
contains help files of R functions

- [`DESCRIPTION`](https://github.com/scarabel/epiverseworkshop3/tree/main/DESCRIPTION):
contains project metadata (author, date, dependencies, etc.)

- [`make.R`](https://github.com/scarabel/epiverseworkshop3/tree/main/make.R):
main R script to run the entire project by calling each R script stored in the `analyses/` folder



### Usage

First, clone this repository. You can follow [steps on creating a new Rstudio Project from a GitHub repository](https://www.epirhandbook.com/en/version-control-and-collaboration-with-git-and-github.html?q=clone#clone-from-a-github-repository). 

Then, run:

```{r eval = FALSE}
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

Owner

Citation (CITATION.cff)

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "epiverseworkshop3" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'epiverseworkshop3: The Reproducible of the Project'
version: 0.0.0.9000
abstract: A paragraph providing a full description of the project (on several lines...)
authors:
- family-names: Scarabel
  given-names: Francesca
  email: francesca.scarabel@gmail.com
  orcid: https://orcid.org/0000-0003-0250-4555
repository-code: https://github.com/scarabel/epiverseworkshop3
url: https://github.com/scarabel/epiverseworkshop3
contact:
- family-names: Scarabel
  given-names: Francesca
  email: francesca.scarabel@gmail.com
  orcid: https://orcid.org/0000-0003-0250-4555

GitHub Events