README.Rmd 1.8 KB
Newer Older
Dorchies David's avatar
Dorchies David committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r opts, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

16
# hubeau an R package for the Hub'eau APIs
Dorchies David's avatar
Dorchies David committed
17

18
19
<img src="man/figures/logo.svg" align="right" height="120px"/>

Dorchies David's avatar
Dorchies David committed
20
21
22
23
24
<!-- badges: start -->
`r badger::badge_license(color = "orange")`
`r badger::badge_lifecycle("experimental", color = "blue")`
<!-- badges: end -->

25
'hubeau' is an R-package proposing a collection of function to help retrieve data from the French national databases on water: https://hubeau.eaufrance.fr
Dorchies David's avatar
Dorchies David committed
26
27
28

## Installation

29
You can install the 'hubeau' R-package from it's development repository with:
Dorchies David's avatar
Dorchies David committed
30
31
32

``` r
install.packages("remotes")
33
remotes::install_gitlab("in-wop/hubeau", host = "gitlab.irstea.fr")
Dorchies David's avatar
Dorchies David committed
34
35
```

36
## Loading library
Dorchies David's avatar
Dorchies David committed
37
38

```{r library}
39
library(hubeau)
Dorchies David's avatar
Dorchies David committed
40
41
```

42
## Get started
43

44
See the package documentation by typing:
45
46


47
```r
48
49
?hubeau
```
50

51
Each function is documented with at least one example: 
52
53

```{r}
54
example("get_prelevements_chroniques")
55
56
```

57
58
59
## Acknowledgement

The authors would like to thank the European Commission and the French National Research Agency (ANR) for funding in the frame of the collaborative  international consortium [IN-WOP](http://www.waterjpi.eu/joint-calls/joint-call-2018-waterworks-2017/booklet/in-wop) financed under the 2018 Joint call of the WaterWorks2017 ERA-NET Cofund. This ERA-NET is an integral part of the activities developed by the Water JPI.
60

61
<div style="display: flex; justify-content: space-between;">![Water JPI](man/figures/logo_water_jpi.png) ![Water Works 2017](man/figures/logo_water_works_2017.png) ![European Commission](man/figures/logo_european_commission.jpg) ![2018 Joint call](man/figures/logo_2018_joint_call.png)</div>