https://github.com/avallecam/rcompendium-test3

:package: The Title of the Project
https://github.com/avallecam/rcompendium-test3

Last synced: 1 day ago
JSON representation

:package: The Title of the Project

• Host: GitHub
• URL: https://github.com/avallecam/rcompendium-test3
• Owner: avallecam
• License: gpl-2.0
• Created: 2023-08-02T16:14:53.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-10T17:57:43.000Z (over 1 year ago)
• Last Synced: 2023-08-10T23:10:57.684Z (over 1 year ago)
• Language: R
• Homepage: https://avallecam.github.io/rcompendium-test3/
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(collapse  = TRUE,

                      comment   = "#>",

                      fig.path  = "man/figures/",

                      out.width = "100%")

```

# rcompendium-test3

[![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/avallecam/rcompendium-test3/tree/master/data):

contains all raw data required to perform analyses

- [`analyses/`](https://github.com/avallecam/rcompendium-test3/tree/main/analyses/):

contains R scripts to run each step of the workflow

- [`outputs/`](https://github.com/avallecam/rcompendium-test3/tree/main/outputs):

contains all the results created during the workflow

- [`figures/`](https://github.com/avallecam/rcompendium-test3/tree/main/figures):

contains all the figures created during the workflow

- [`R/`](https://github.com/avallecam/rcompendium-test3/tree/main/R):

contains R functions developed especially for this project

- [`man/`](https://github.com/avallecam/rcompendium-test3/tree/main/man):

contains help files of R functions

- [`DESCRIPTION`](https://github.com/avallecam/rcompendium-test3/tree/main/DESCRIPTION):

contains project metadata (author, date, dependencies, etc.)

- [`make.R`](https://github.com/avallecam/rcompendium-test3/tree/main/make.R):

main R script to run the entire project by calling each R script stored in the `analyses/` folder

### Usage

Clone the repository, open R/RStudio and 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