文件列表:

R/
data-raw/
dev/
inst/
man-roxygen/
man/
pkgdown/favicon/
tests/
vignettes/
.Rbuildignore
CRAN-SUBMISSION
DESCRIPTION
LICENSE
LICENSE.md
NAMESPACE
NEWS.md
_pkgdown.yml
cran-comments.md
hubeau.Rproj

# hubeau an R package for the Hub’Eau APIs [](https://cran.r-project.org/package=hubeau) [](https://cran.r-project.org/package=hubeau) [](https://doi.org/10.57745/XKN6NC) [](https://cran.r-project.org/web/licenses/MIT) [](https://lifecycle.r-lib.org/articles/stages.html#stable) [](https://github.com/inrae/hubeau/actions/workflows/R-CMD-check.yaml) ‘hubeau’ is an R-package proposing a collection of function to help retrieve data from the French national databases on water: # Installation ``` r # Install released version from CRAN install.packages("hubeau") # Install development version from GitHub: # install.packages("remotes") remotes::install_github("inrae/hubeau") ``` # Loading library ``` r library(hubeau) ``` # Get started The ‘hubeau’ package provides functions for ‘Hub’Eau’ APIs and their related endpoints. These functions are named as follow: `hubeau::get_[API]_[endpoint]`. Currently available APIs and related endpoints are listed below. ## API “Ecoulement des cours d’eau” API documentation: Available functions: - [`get_ecoulement_stations`](https://inrae.github.io/hubeau/reference/get_ecoulement.html): site data and locations - [`get_ecoulement_observations`](https://inrae.github.io/hubeau/reference/get_ecoulement.html): flow observations collected during campaigns - [`get_ecoulement_campagnes`](https://inrae.github.io/hubeau/reference/get_ecoulement.html): observation campaign information ## API “Hydrométrie” API documentation: Available functions: - [`get_hydrometrie_sites`](https://inrae.github.io/hubeau/reference/get_hydrometrie.html): hydrometry sites (can contain several stations) - [`get_hydrometrie_stations`](https://inrae.github.io/hubeau/reference/get_hydrometrie.html): hydrometry stations - [`get_hydrometrie_observations_tr`](https://inrae.github.io/hubeau/reference/get_hydrometrie.html): hydrometry water level and discharge time series - [`get_hydrometrie_obs_elab`](https://inrae.github.io/hubeau/reference/get_hydrometrie.html): hydrometric elaborate observations (daily/monthly mean flow) ## API “Indicateurs des services” API documentation: Available functions: - [`get_indicateurs_services_communes`](https://inrae.github.io/hubeau/reference/get_indicateurs_services.html): performance indicators by commune - [`get_indicateurs_services_indicateurs`](https://inrae.github.io/hubeau/reference/get_indicateurs_services.html): performance indicators by indicator - [`get_indicateurs_services_services`](https://inrae.github.io/hubeau/reference/get_indicateurs_services.html): performance indicators by commune for each service ## API “Piézométrie” API documentation: Available functions: - [`get_niveaux_nappes_chroniques`](https://inrae.github.io/hubeau/reference/get_niveaux_nappes.html): archived time series of piezometric stations - [`get_niveaux_nappes_chroniques_tr`](https://inrae.github.io/hubeau/reference/get_niveaux_nappes.html): real-time time series of piezometric stations - [`get_niveaux_nappes_stations`](https://inrae.github.io/hubeau/reference/get_niveaux_nappes.html): piezometric stations ## API “Poisson” API documentation: Available function: - [`get_poisson_observations`](https://inrae.github.io/hubeau/reference/get_poisson.html): scientific fishery observations ## API “Prélèvements en eau” API documentation: Available functions: - [`get_prelevements_chroniques`](https://inrae.github.io/hubeau/reference/get_prelevements.html): time series of annual withdrawn volumes by device - [`get_prelevements_ouvrages`](https://inrae.github.io/hubeau/reference/get_prelevements.html): withdrawal devices (can contain several withdrawal points) - [`get_prelevements_points_prelevement`](https://inrae.github.io/hubeau/reference/get_prelevements.html): withdrawal points ## API “Qualité de l’eau potable” API documentation: Available functions: - [`get_qualite_eau_potable_communes_udi`](https://inrae.github.io/hubeau/reference/get_qualite_eau_potable.html): links between “UDI” (Distribution units or networks) and communes - [`get_qualite_eau_potable_resultats_dis`](https://inrae.github.io/hubeau/reference/get_qualite_eau_potable.html): samples, analysis results and sanitary conclusions from the sanitary control of the distributed water commune by commune ## API “Qualité des nappes d’eau souterraines” API documentation: Available functions: - [`get_qualite_nappes_stations`](https://inrae.github.io/hubeau/reference/get_qualite_nappes.html): measuring stations for groundwater quality - [`get_qualite_nappes_analyses`](https://inrae.github.io/hubeau/reference/get_qualite_nappes.html): analysis results of quality measurement ## API “Température des cours d’eau” API Documentation Available functions: - [`get_temperature_stations`](https://inrae.github.io/hubeau/reference/get_temperature.html): temperature stations in French rivers - [`get_temperature_chronique`](https://inrae.github.io/hubeau/reference/get_temperature.html): river temperature time series A complete documentation is available on the package website: # Acknowledgements 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.

   

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：