-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.Rmd
More file actions
59 lines (38 loc) · 1.41 KB
/
README.Rmd
File metadata and controls
59 lines (38 loc) · 1.41 KB
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
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```
# Samples utilities
<img src=".github/images/restoreplus_sticker.png" alt="Restore+ icon" align="right" height="150" width="150"/>
<!-- badges: start -->
<!-- badges: end -->
Useful scripts and functions to facilitate the analysis of samples within the Restore+ Project.
## Getting started
To get started with the examples in this repository, first clone the repository:
```sh
git clone https://github.com/restore-plus/samples-utils
```
Next, open the `samples-utils` directory in the RStudio and install the package:
```r
devtools::install(".")
```
You can also use [renv](https://rstudio.github.io/renv/):
```r
renv::restore()
```
## Repository structure
- `data/`: Auxiliary data
- `analysis/`: Processing scripts
- `R/`: Utilities for the processing scripts
## Contributing
Contributions are welcome! If you have an example that you'd like to share, please submit a pull request. Make sure your example is well-documented and includes all necessary data and scripts.
## License
The source code in this repository is licensed under GNU GENERAL PUBLIC LICENSE V3. Data and results are under the Creative Commons [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) License.
## Contact
For questions or suggestions, please open an issue or contact the repository maintainers.
---