-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
82 lines (46 loc) · 2.15 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%")
```
# fndat
<!-- badges: start -->
[](https://choosealicense.com/licenses/gpl-2.0/)
[](#)
<!-- badges: end -->
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/david-beauchesne/fndat/tree/master/data):
contains all raw data required to perform analyses
- [`analyses/`](https://github.com/david-beauchesne/fndat/tree/master/analyses/):
contains R scripts to run each step of the workflow
- [`outputs/`](https://github.com/david-beauchesne/fndat/tree/master/outputs):
contains all the results created during the workflow
- [`figures/`](https://github.com/david-beauchesne/fndat/tree/master/figures):
contains all the figures created during the workflow
- [`R/`](https://github.com/david-beauchesne/fndat/tree/master/R):
contains R functions developed especially for this project
- [`man/`](https://github.com/david-beauchesne/fndat/tree/master/man):
contains help files of R functions
- [`DESCRIPTION`](https://github.com/david-beauchesne/fndat/tree/master/DESCRIPTION):
contains project metadata (author, date, dependencies, etc.)
- [`make.R`](https://github.com/david-beauchesne/fndat/tree/master/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