R/get_indicateurs_services.R
get_indicateurs_services.Rd
Retrieve performance indicators collected in drinking water and sanitation services in France.
See list_params and the API documentation for available filter parameters: https://hubeau.eaufrance.fr/page/api-indicateurs-services
get_indicateurs_services_communes(...)
get_indicateurs_services_indicateurs(...)
get_indicateurs_services_services(...)
parameters of the queries and their values in the format
Param1_Name = "Param1 value", Param2_Name = "Param2 value"
, use the
function list_params for a list of the available filter parameters
for a given API endpoint and see the API documentation for their description
get_indicateurs_services_communes
returns a tibble::tibble with one row by commune, by service and by year and the following columns:
"code_commune_insee": character identifier of the commune
"nom_commune": character name of the commune
"codes_service": integer identifier of the drinking water supply and/or sanitation service
"annee": integer year of the data
The following columns are the performance indicators flagged by their respective codes. The documentation of these codes can be found at this URL: https://www.services.eaufrance.fr/indicateurs/indicateurs.
get_indicateurs_services_indicateurs
returns a tibble::tibble with one row by service and by year and the following columns:
"code_service": character identifier of the service
"nom_service": character name of the service
"numero_siren ": character SIREN identifier of the service
"type_collectivite": character kind of community
"mode_gestion": character management mechanism of the service
"annee": integer year of the data
"indicateur": value of the indicator
"uri_indicateur": the link to the indicator documentation
get_indicateurs_services_services
returns a tibble::tibble with one row by commune, by service and by year and the following columns:
"code_service": character identifier of the service
"nom_service": character name of the service
"code_commune_insee": character identifier of the commune
"nom_commune": character name of the commune
"numero_siren ": character SIREN identifier of the service
"type_collectivite": character kind of community
"mode_gestion": character management mechanism of the service
"annee": integer year of the data
The following columns are the performance indicators flagged by their respective codes. The documentation of these codes can be found at this URL: https://www.services.eaufrance.fr/indicateurs/indicateurs.
# \dontrun{
# Retrieve performance indicator time series in the commune of Romilly-sur-Seine
get_indicateurs_services_communes(code_commune = "10323")
#> # A tibble: 28 × 39
#> code_com…¹ nom_c…² codes…³ noms_…⁴ annee D102.0 D151.0 P101.1 P101.1a P101.1b
#> <chr> <chr> <int> <chr> <int> <dbl> <dbl> <dbl> <lgl> <lgl>
#> 1 10323 Romill… 148782 eau po… 2018 1.91 1 100 NA NA
#> 2 10323 Romill… 148782 eau po… 2017 2.07 1 100 NA NA
#> 3 10323 Romill… 148783 assain… 2017 NA NA NA NA NA
#> 4 10323 NA 148783 assain… 2017 NA NA NA NA NA
#> 5 10323 Romill… 148782 eau po… 2016 2.18 1 100 NA NA
#> 6 10323 Romill… 148783 assain… 2016 NA NA NA NA NA
#> 7 10323 NA 148783 assain… 2016 NA NA NA NA NA
#> 8 10323 Romill… 148782 eau po… 2015 2.2 1 100 NA NA
#> 9 10323 NA 148783 assain… 2015 NA NA NA NA NA
#> 10 10323 Romill… 148783 assain… 2015 NA NA NA NA NA
#> # … with 18 more rows, 29 more variables: P102.1 <dbl>, P102.1a <lgl>,
#> # P102.1b <lgl>, P104.3 <dbl>, P106.3 <dbl>, P107.2 <dbl>, P108.3 <dbl>,
#> # P151.1 <dbl>, P152.1 <dbl>, P155.1 <dbl>, VP.177 <dbl>, VP.190 <dbl>,
#> # VP.178 <dbl>, VP.191 <dbl>, VP.179 <dbl>, VP.061 <dbl>, DC.192 <dbl>,
#> # VP.228 <dbl>, VP.231 <dbl>, D204.0 <dbl>, P201.1 <dbl>, P203.3 <dbl>,
#> # P204.3 <dbl>, P205.3 <dbl>, P258.1 <dbl>, VP.186 <dbl>, VP.176 <dbl>,
#> # VP.023 <dbl>, VP.229 <dbl>, and abbreviated variable names …
# Retrieve the drinking water withdrawal indicators of the year 2012 for all services
get_indicateurs_services_indicateurs(code_indicateur = "D102.0", annee = "2012")
#> # A tibble: 5,471 × 8
#> code_service nom_service numero_siren type_co…¹ mode_…² annee indic…³ uri_i…⁴
#> <int> <chr> <chr> <chr> <chr> <int> <dbl> <chr>
#> 1 99941 eau potable 258803303 Syndicat… Régie 2012 NA http:/…
#> 2 99919 eau potable NA Syndicat… Régie 2012 NA http:/…
#> 3 99917 eau potable 258800838 Syndicat… Déléga… 2012 2.72 http:/…
#> 4 99916 eau potable 258800028 Syndicat… Régie 2012 1.44 http:/…
#> 5 99915 eau potable 258800275 Syndicat… Régie 2012 1.59 http:/…
#> 6 99914 eau potable 248800237 Syndicat… Régie 2012 NA http:/…
#> 7 99913 eau potable 258800911 Syndicat… Régie 2012 2.17 http:/…
#> 8 99911 eau potable 258803048 Syndicat… Régie 2012 1.69 http:/…
#> 9 99910 eau potable 258800044 Syndicat… Régie 2012 1.90 http:/…
#> 10 99909 eau potable 258800713 Syndicat… Régie 2012 1.50 http:/…
#> # … with 5,461 more rows, and abbreviated variable names ¹type_collectivite,
#> # ²mode_gestion, ³indicateur, ⁴uri_indicateur
# Retrieve performance indicator time series of Romilly-sur-Seine with service details
get_indicateurs_services_services(code_commune = "10323")
#> # A tibble: 9 × 38
#> code_ser…¹ nom_s…² codes…³ noms_…⁴ numer…⁵ type_…⁶ mode_…⁷ annee D101.0 D102.0
#> <int> <chr> <chr> <chr> <chr> <chr> <chr> <int> <lgl> <dbl>
#> 1 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2019 NA 1.72
#> 2 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2018 NA 1.91
#> 3 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2017 NA 2.07
#> 4 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2016 NA 2.18
#> 5 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2015 NA 2.2
#> 6 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2014 NA 2.25
#> 7 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2013 NA 1.98
#> 8 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2010 NA 1.52
#> 9 148782 eau po… 10323 Romill… 211003… Commune Déléga… 2009 NA 1.50
#> # … with 28 more variables: D151.0 <dbl>, P101.1 <dbl>, P101.1a <lgl>,
#> # P101.1b <lgl>, P102.1 <dbl>, P102.1a <lgl>, P102.1b <lgl>, P104.3 <dbl>,
#> # P106.3 <dbl>, P107.2 <dbl>, P108.3 <dbl>, P151.1 <dbl>, P152.1 <dbl>,
#> # P155.1 <dbl>, VP.056 <lgl>, VP.177 <dbl>, VP.190 <dbl>, VP.178 <dbl>,
#> # VP.191 <dbl>, VP.179 <dbl>, VP.059 <lgl>, VP.060 <lgl>, VP.061 <dbl>,
#> # VP.063 <lgl>, VP.201 <lgl>, DC.192 <dbl>, VP.228 <dbl>, VP.231 <dbl>, and
#> # abbreviated variable names ¹code_service, ²nom_service, ³codes_commune, …
# }