-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
120 lines (65 loc) · 4.08 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
---
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%")
```
rphenofish <img src="man/figures/logo.png" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://github.com/PhenoFish/rphenofish/actions/workflows/R-CMD-check.yaml)
[](https://github.com/PhenoFish/rphenofish/actions/workflows/pkgdown.yaml)
[](https://codecov.io/gh/PhenoFish/rphenofish)
[](https://CRAN.R-project.org/package=rphenofish)
[](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
## Table of contents
<p align="left">
• <a href="#overview">Overview</a><br>
• <a href="#features">Features</a><br>
• <a href="#installation">Installation</a><br>
• <a href="#get-started">Get started</a><br>
• <a href="#documentation">Documentation</a><br>
• <a href="#citation">Citation</a><br>
• <a href="#contributing">Contributing</a><br>
• <a href="#acknowledgments">Acknowledgments</a><br>
• <a href="#references">References</a>
</p>
## Overview
The goal of the R package `rphenofish` is to provide an interface to the PHENOFISH database. **{{ ADD A FEW LINES }}**
## Features
The main purpose of the `rphenofish` package is to download, select, filter, homogenize, and visualize PHENOFISH data. The [References](https://phenofish.github.io/rphenofish/reference/index.html) page provides a full description of the features available in the package.
## Installation
You can install the development version from [GitHub](https://github.com/) with:
```{r eval=FALSE}
## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
## Install dev version of < rphenofish > from GitHub ----
remotes::install_github("PhenoFish/rphenofish")
```
Then you can attach the package `rphenofish`:
```{r eval=FALSE}
library("rphenofish")
```
## Get started
For an overview of the main features of `rphenofish`, please read the [Get started](https://phenofish.github.io/rphenofish/articles/rphenofish.html) vignette.
## Documentation
`rphenofish` provides **{{ XX }}** vignettes to learn more about the package:
- the [Get started](https://phenofish.github.io/rphenofish/articles/rphenofish.html) vignette describes the core features of the package
- other vignettes will come soon
## Citation
Please cite this package as:
> Casajus N & Loiseau N (`r format(Sys.Date(), "%Y")`) rphenofish: An R client to access the PHENOFISH database. R package version 0.0.0.9000. URL: https://phenofish.github.io/rphenofish/.
## Contributing
All types of contributions are encouraged and valued. For more information, check out our [Contributor Guidelines](https://github.com/phenofish/rphenofish/blob/main/CONTRIBUTING.md).
Please note that the `rphenofish` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
## Acknowledgments
This package has been developed for the [FRB-CESAB](https://www.fondationbiodiversite.fr/en/about-the-foundation/le-cesab/) working group [PHENOFISH](https://www.fondationbiodiversite.fr/en/the-frb-in-action/programs-and-projects/le-cesab/phenofish/) that aims to pool data on the biodiversity, morphology, behaviour and ecophysiology of marine and freshwater fishes that have never before been brought together.
## References
...