hubeau.R 1.04 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
#' - [get_hydrometrie_sites]
14
15
#' - [get_hydrometrie_stations]
#'
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#' **API "Indicateurs des services"**
#'
#' API documentation: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
#'
#' Available functions:
#'
#' - [get_indicateurs_services_communes]
#' - [get_indicateurs_services_indicateurs]
#'
#' **API "Prélèvements en eau"**
#'
#' API documentation: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
#'
#' Available functions:
#'
#' - [get_prelevements_chroniques]
32
#' - [get_prelevements_ouvrages]
33
34
35
36
37
38
#' - [get_prelevements_points_prelevement]
#'
#' @docType package
#' @name hubeau
#'
NULL