hubeau.Rd 2.01 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hubeau.R
\docType{package}
\name{hubeau}
\alias{hubeau}
\title{hubeau: A package for retrieving data on the French databases on water "Hub'eau"}
\description{
The 'hubeau' package provides functions for APIs and related "operations". These functions are named as follow: \verb{hubeau::get_[API]_[operation]}.
}
\details{
Currently available APIs and related "operations" are listed below.

13
14
15
16
17
18
\strong{API "Hydrométrie"}

API documentation: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}

Available functions:
\itemize{
19
20
21
\item \link{get_hydrometrie_observations_tr}: hydrometry water level and discharge time series
\item \link{get_hydrometrie_sites}: hydrometry sites (can contain several stations)
\item \link{get_hydrometrie_stations}: hydrometry stations
22
23
}

24
25
26
27
28
29
\strong{API "Indicateurs des services"}

API documentation: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}

Available functions:
\itemize{
30
31
\item \link{get_indicateurs_services_communes}: performance indicators by commune
\item \link{get_indicateurs_services_indicateurs}: performance indicators by indicator
32
\item \link{get_indicateurs_services_services}: performance indicators by commune for each service
33
34
}

35
36
37
38
39
40
\strong{API "Piézométrie"}

API documentation: \url{https://hubeau.eaufrance.fr/page/api-piezometrie}

Available functions:
\itemize{
41
42
43
\item \link{get_hydrometrie_chroniques}: archived time series of piezometric stations
\item \link{get_hydrometrie_chroniques_tr}: real-time time series of piezometric stations
\item \link{get_niveaux_nappes_stations}: piezometric stations
44
45
}

46
47
48
49
50
51
\strong{API "Prélèvements en eau"}

API documentation: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}

Available functions:
\itemize{
52
53
54
\item \link{get_prelevements_chroniques}: time series of annual withdrawn volumes by device
\item \link{get_prelevements_ouvrages}: withdrawal devices (can contain several withdrawal points)
\item \link{get_prelevements_points_prelevement}: withdrawal points
55
56
}
}