hubeau.R 1.84 KB
Newer Older
1
2
3
4
5
6
#' hubeau: A package for retrieving data on the French databases on water "Hub'eau"
#'
#' The 'hubeau' package provides functions for APIs and related "operations". These functions are named as follow: `hubeau::get_[API]_[operation]`.
#'
#' Currently available APIs and related "operations" are listed below.
#'
7
8
9
10
11
12
#' **API "Hydrométrie"**
#'
#' API documentation: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
#'
#' Available functions:
#'
13
14
15
#' - [get_hydrometrie_observations_tr]: hydrometry water level and discharge time series
#' - [get_hydrometrie_sites]: hydrometry sites (can contain several stations)
#' - [get_hydrometrie_stations]: hydrometry stations
16
#'
17
18
19
20
21
22
#' **API "Indicateurs des services"**
#'
#' API documentation: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
#'
#' Available functions:
#'
23
24
#' - [get_indicateurs_services_communes]: performance indicators by commune
#' - [get_indicateurs_services_indicateurs]: performance indicators by indicator
25
#' - [get_indicateurs_services_services]: performance indicators by commune for each service
26
#'
27
28
29
30
31
32
#' **API "Piézométrie"**
#'
#' API documentation: \url{https://hubeau.eaufrance.fr/page/api-piezometrie}
#'
#' Available functions:
#'
33
34
35
#' - [get_hydrometrie_chroniques]: archived time series of piezometric stations
#' - [get_hydrometrie_chroniques_tr]: real-time time series of piezometric stations
#' - [get_niveaux_nappes_stations]: piezometric stations
36
#'
37
38
39
40
41
42
#' **API "Prélèvements en eau"**
#'
#' API documentation: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
#'
#' Available functions:
#'
43
44
45
#' - [get_prelevements_chroniques]: time series of annual withdrawn volumes by device
#' - [get_prelevements_ouvrages]: withdrawal devices (can contain several withdrawal points)
#' - [get_prelevements_points_prelevement]: withdrawal points
46
47
48
49
50
#'
#' @docType package
#' @name hubeau
#'
NULL