-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
181 lines (137 loc) · 7.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
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
---
title: "ReLTER"
output:
github_document: default
html_document: default
always_allow_html: yes
editor_options:
markdown:
wrap: 72
---
<!-- 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/README-",
fig.ext = 'png',
out.width = "100%")
```
<!-- badges: start -->
<!-- other badges https://github.com/GuangchuangYu/badger -->
<!-- DOI badge -->
`r badger::badge_doi("10.5281/zenodo.5576813", "yellow")`
`r badger::badge_devel("ropensci/ReLTER", "blue")`
`r badger::badge_code_size("ropensci/ReLTER")`
`r badger::badge_last_commit("ropensci/ReLTER")`
`r badger::badge_license("GPL-3")` [](https://www.repostatus.org/#active)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
`r badger::badge_github_actions("rossellhayes/ipa")`
[](https://ropengov.r-universe.dev/)
[](https://codecov.io/gh/ropensci/ReLTER)
[](https://github.com/ropensci/software-review/issues/485)
<!-- CRAN badges -->
<!-- `r badger::badge_cran_release("ropensci/ReLTER", "orange")` -->
<!-- `r badger::badge_cran_checks("ReLTER")` -->
<!-- `r badger::badge_cran_download("badger", "last-month", "green")` -->
<!-- `r badgecreatr::badge_rdocumentation("ReLTER")` -->
<!-- badges: end -->
`{ReLTER}` is an R package that provides access to
[DEIMS-SDR](https://deims.org/), allowing to interact with software
implemented by eLTER Research Infrastructure (RI) and improving the
data/information shared among the Long Term Ecological Research (LTER)
network. This package was conceived within eLTER H2020 project and will
help advance the development of European Long-Term Ecosystem Research
Infrastructures ([eLTER RI](https://elter-ri.eu)).
The `{ReLTER}` package functions in particular allows to:
- retrieve the information about entities (e.g. sites, datasets, and
activities) shared by [DEIMS-SDR](https://deims.org/) (see e.g.
[get_site_info
function](https://docs.ropensci.org/ReLTER/reference/get_site_info.html));
- elaborate the information of single site or merge info from national
network sites or entire International LTER (ILTER) in order to
provide maps, figures, graphs etc (see e.g.
[get_network_sites](https://docs.ropensci.org/ReLTER/reference/get_network_sites.html),
[produce_site_map](https://docs.ropensci.org/ReLTER/reference/produce_site_map.html)
or
[produce_site_observedProperties_pie](https://docs.ropensci.org/ReLTER/reference/produce_site_observedProperties_pie.html)
functions);
- interact with the [ODSEurope](maps.opendatascience.eu) managed by
members of the
[Geo-harmonizer](https://opendatascience.eu/geoharmonizer-project/)
project starting with the dataset shared by
[DEIMS-SDR](https://deims.org/) (see e.g.
[get_site_ODS](https://docs.ropensci.org/ReLTER/reference/get_site_ODS.html)
function);
- improve the quality of the dataset (see e.g.
[get_id_worms](https://docs.ropensci.org/ReLTER/reference/get_id_worms.html)).
Functions currently implemented are derived from the discussion of the
needs declared by eLTER users community.
The `{ReLTER}` package will follow the progress of eLTER-RI
infrastructure and evolve with improvements and development of new
tools.
<!-- about the icons https://github.com/ikatyang/emoji-cheat-sheet -->
## :notebook_with_decorative_cover: Citation
To cite `{ReLTER}` please use: Alessandro Oggioni, Micha Silver, Luigi Ranghetti
& Paolo Tagliolato. (2023). ReLTER: An Interface for the eLTER Community
(v2.1). Zenodo. <https://doi.org/10.5281/zenodo.5576813>
or:
``` bibtex
@software{alessandro_oggioni_2021_5576813,
author = {Alessandro Oggioni and Micha Silver and Luigi Ranghetti and Paolo Tagliolato},
title = {ReLTER: An Interface for the eLTER Community},
month = jan,
year = 2023,
publisher = {Zenodo},
version = {v2.1},
doi = {10.5281/zenodo.5576813},
url = {https://doi.org/10.5281/zenodo.5576813}
}
```
## :book: Documentation
Visit the `{ReLTER}` website at
[docs.ropensci.org/ReLTER/](https://docs.ropensci.org/ReLTER/) for
further documentation, examples, and installation of the package.
The manual of `{ReLTER}` package could be found
[here](https://ropensci.r-universe.dev/manual/ReLTER.pdf).
## :arrow_double_down: Installation
You can install the main version of `{ReLTER}` from
[GitHub](https://github.com/ropensci/ReLTER) with:
install.packages("devtools")
devtools::install_github("ropensci/ReLTER")
library(ReLTER)
If you want to install different package branch (e.g. 'dev') can you use this command:
devtools::install_github('https://github.com/ropensci/ReLTER', ref = 'dev')
The `{ReLTER}` package is part of the [R-universe](https://r-universe.dev/) community
and it can be installed also use this command:
utils::install.packages("ReLTER", repos = "https://ropensci.r-universe.dev")
Alternatively {`ReLTER`} can be used [in a Docker container](./articles/rocker_ReLTER.html).
If you wish to help develop this package, please follow the
[contributing guidelines](CONTRIBUTING.md).
## :woman_technologist: Persons involved :man_technologist:
Alessandro Oggioni <https://orcid.org/0000-0002-7997-219X> (CNR,
Institute for Electromagnetic Sensing of the Environment - IREA)
<!-- Add authors, reviewers including those who, within eLTER network, reviewed the package and add acknowledgements
in accordance with this https://ropensci.org/blog/2018/03/16/thanking-reviewers-in-metadata/ and this
https://devguide.ropensci.org/building.html#authorship.
Add the same in DESCRIPTION file -->
Micha Silver <https://orcid.org/0000-0002-1128-1325> (Ben Gurion
University - BGU)
Luigi Ranghetti <https:://orcid.org/0000-0001-6207-5188> (CNR, Institute
for Electromagnetic Sensing of the Environment - IREA)
Paolo Tagliolato <https:://orcid.org/0000-0002-0261-313X> (CNR,
Institute for Electromagnetic Sensing of the Environment - IREA)
For a exhaustive list of contributors please visit [authors
page](https://docs.ropensci.org/ReLTER/authors).
## :office: Contributing organizations
{height="72"}
<!--a href="http://www.irea.cnr.it/en/"><img src="man/figures/irea_logo.png" height="40" align="left" /></a-->
{height="80"}
<!--a href="https://in.bgu.ac.il/en/"><img src="man/figures/bgu_logo.png" height="40" align="left" /></a-->
## :thumbsup: Acknowledgements
This work has been partially funded from the European Union's Horizon
2020 research and innovation programme under the [H2020 eLTER-Plus
Project](https://elter-ri.eu/elter-plus) grant agreement No 871128.
Thanks to the reviewers and the editor ([more about authors](https://docs.ropensci.org/ReLTER/authors.html)) for their work.