-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.Rmd
More file actions
91 lines (60 loc) · 3.62 KB
/
README.Rmd
File metadata and controls
91 lines (60 loc) · 3.62 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
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
---
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%")
```
# BioExtremeEvent <img src="man/figures/package-sticker.png" align="right" style="float:right; height:120px;"/>
<!-- badges: start -->
[](https://github.com/VicoDelannoy/BioExtremeEvent/actions/workflows/pkgdown.yaml)
[](https://github.com/VicoDelannoy/BioExtremeEvent/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
<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="#long-form-documentations">Long-form documentations</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 R package `BioExtremeEvent` identifies and characterises an extreme event in
time and space for a given GPS point (e.g. a sampling site) or for every pixel
in a given area.
## 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 < BioExtremeEvent > from GitHub ----
remotes::install_github("VicoDelannoy/BioExtremeEvent")
```
Then you can attach the package `BioExtremeEvent`:
```{r eval=FALSE}
library("BioExtremeEvent")
```
## Get started
For an overview of the main features of `BioExtremeEvent`, please read the [Get started](https://VicoMarbec.github.io/BioExtremeEvent/articles/BioExtremeEvent.html) vignette.
## Long-form documentations
`BioExtremeEvent` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn more about the package:
- the [Get started](https://VicoMarbec.github.io/BioExtremeEvent/articles/BioExtremeEvent.html) vignette describes the core features of the package
- **{{ LIST ADDITIONAL VIGNETTES }}**
## Citation
Please cite `BioExtremeEvent` as:
> Delannoy Victoria, Cabrol Nicolas, Casajus Nicolas, Fièvre Céleste,
Loiseau Nicolas\*, Villéger Sébastien\*, (`r format(Sys.Date(), "%Y")`)
BioExtremeEvent: An R package to **characterise extreme event**. R package
version 0.0.900. <https://github.com/VicoMarbec/BioExtremeEvent/>
## Contributing
All types of contributions are encouraged and valued. For more information, check out our [Contributor Guidelines](https://github.com/VicoMarbec/BioExtremeEvent/blob/main/CONTRIBUTING.md).
Please note that the `BioExtremeEvent` 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
**{{ OPTIONAL SECTION }}**
## References
The dataset used in the exemple comes from :
Embury, O., Merchant, C.J., Good, S.A., Rayner, N.A., Høyer, J.L., Atkinson, C.,
Block, T., Alerskans, E., Pearson, K.J., Worsfold, M., McCarroll, N.,
Donlon, C., (2024). Satellite-based time-series of sea-surface temperature since
1980 for climate applications. Sci Data 11, 326.
doi: https://doi.org/10.1038/s41597-024-03147-w