From 99900e711010badcc274267e3704189a5dd319e9 Mon Sep 17 00:00:00 2001 From: David Dorchies <14124454+DDorch@users.noreply.github.com> Date: Thu, 22 Feb 2024 10:40:38 +0100 Subject: [PATCH 1/2] fix: warning @docType "package" is deprecated Refs #39 --- R/hubeau.R | 4 +++- man/hubeau-package.Rd | 32 ++++++++++++++++++++++++++++++++ man/hubeau.Rd | 22 ---------------------- 3 files changed, 35 insertions(+), 23 deletions(-) create mode 100644 man/hubeau-package.Rd diff --git a/R/hubeau.R b/R/hubeau.R index 484e07c..3361e11 100644 --- a/R/hubeau.R +++ b/R/hubeau.R @@ -1,10 +1,12 @@ +#' @keywords internal +"_PACKAGE" + #' @title hubeau: A package for retrieving data on the French databases on water 'Hub'Eau' #' #' @description #' ```{r child = "man-roxygen/hubeau.md"} #' ``` #' -#' @docType package #' @import utils #' @name hubeau #' diff --git a/man/hubeau-package.Rd b/man/hubeau-package.Rd new file mode 100644 index 0000000..03194dc --- /dev/null +++ b/man/hubeau-package.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/hubeau.R +\docType{package} +\name{hubeau-package} +\alias{hubeau-package} +\title{hubeau: Get Data from the French National Database on Water 'Hub'Eau'} +\description{ +\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} + +Collection of functions to help retrieving data from 'Hub'Eau' the free and public French National APIs on water \url{https://hubeau.eaufrance.fr/}. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://inrae.github.io/hubeau/} + \item \url{https://github.com/inrae/hubeau#readme} + \item Report bugs at \url{https://github.com/inrae/hubeau/issues} +} + +} +\author{ +\strong{Maintainer}: David Dorchies \email{david.dorchies@inrae.fr} (\href{https://orcid.org/0000-0002-6595-7984}{ORCID}) + +Other contributors: +\itemize{ + \item Pascal Irz \email{pascal.irz@ofb.gouv.fr} (\href{https://orcid.org/00000-0002-2066-8935}{ORCID}) [contributor] + \item Sébastien Grall \email{seinormigr.grall@gmail.com} [contributor] + \item Philippe Amiotte Suchet \email{philippe.amiotte-suchet@u-bourgogne.fr} (\href{https://orcid.org/0000-0003-3514-1447}{ORCID}) [contributor] +} + +} +\keyword{internal} diff --git a/man/hubeau.Rd b/man/hubeau.Rd index e4e1233..96cc42f 100644 --- a/man/hubeau.Rd +++ b/man/hubeau.Rd @@ -1,8 +1,6 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/hubeau.R -\docType{package} \name{hubeau} -\alias{hubeau-package} \alias{hubeau} \title{hubeau: A package for retrieving data on the French databases on water 'Hub'Eau'} \description{ @@ -116,23 +114,3 @@ Available functions: } } } -\seealso{ -Useful links: -\itemize{ - \item \url{https://inrae.github.io/hubeau/} - \item \url{https://github.com/inrae/hubeau#readme} - \item Report bugs at \url{https://github.com/inrae/hubeau/issues} -} - -} -\author{ -\strong{Maintainer}: David Dorchies \email{david.dorchies@inrae.fr} (\href{https://orcid.org/0000-0002-6595-7984}{ORCID}) - -Other contributors: -\itemize{ - \item Pascal Irz \email{pascal.irz@ofb.gouv.fr} (\href{https://orcid.org/00000-0002-2066-8935}{ORCID}) [contributor] - \item Sébastien Grall \email{seinormigr.grall@gmail.com} [contributor] - \item Philippe Amiotte Suchet \email{philippe.amiotte-suchet@u-bourgogne.fr} (\href{https://orcid.org/0000-0003-3514-1447}{ORCID}) [contributor] -} - -} From f0cc3d7f0c3881f0022eb30b89b36831158193ec Mon Sep 17 00:00:00 2001 From: David Dorchies <14124454+DDorch@users.noreply.github.com> Date: Thu, 22 Feb 2024 10:49:42 +0100 Subject: [PATCH 2/2] docs(README): add qualite rivieres API Refs #9 --- R/get_qualite_rivieres.R | 2 +- README.md | 16 ++++++++++++++++ man-roxygen/hubeau.md | 11 +++++++++++ man/get_qualite_rivieres.Rd | 2 +- man/hubeau.Rd | 13 +++++++++++++ 5 files changed, 42 insertions(+), 2 deletions(-) diff --git a/R/get_qualite_rivieres.R b/R/get_qualite_rivieres.R index 3ea7f0e..cae9d43 100644 --- a/R/get_qualite_rivieres.R +++ b/R/get_qualite_rivieres.R @@ -11,7 +11,7 @@ #' #' - `get_qualite_rivieres_station` retrieves physico-chemical measuring stations #' - `get_qualite_rivieres_operation` retrieves physico-chemical operations -#' - `get_qualite_rivieres_analyse` retrieves physico-chemical analysis +#' - `get_qualite_rivieres_analyse` retrieves physico-chemical analyses #' - `get_qualite_rivieres_condition_environnementale` retrieves physico-chemical #' environmental conditions for analyses (please note that pagination is based #' on the number of analyses) diff --git a/README.md b/README.md index 0afcc42..56b513b 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,22 @@ Available functions: samples, analysis results and sanitary conclusions from the sanitary control of the distributed water commune by commune +## API “Qualité des cours d’eau” + +API documentation: + + +Available functions: + +- [`get_qualite_rivieres_station`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): + measuring stations for river quality +- [`get_qualite_rivieres_operation`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): + physico-chemical operations +- [`get_qualite_rivieres_analyse`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): + results of physico-chemical analyses +- [`get_qualite_rivieres_condition_environnementale`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): + environmental conditions for analyses + ## API “Qualité des nappes d’eau souterraines” API documentation: diff --git a/man-roxygen/hubeau.md b/man-roxygen/hubeau.md index 08eb35b..426223d 100644 --- a/man-roxygen/hubeau.md +++ b/man-roxygen/hubeau.md @@ -73,6 +73,17 @@ Available functions: - [get_qualite_eau_potable_resultats_dis()]: samples, analysis results and sanitary conclusions from the sanitary control of the distributed water commune by commune +## API "Qualité des cours d'eau" + +API documentation: + +Available functions: + +- [get_qualite_rivieres_station()]: measuring stations for river quality +- [get_qualite_rivieres_operation()]: physico-chemical operations +- [get_qualite_rivieres_analyse()]: results of physico-chemical analyses +- [get_qualite_rivieres_condition_environnementale()]: environmental conditions for analyses + ## API "Qualité des nappes d'eau souterraines" API documentation: diff --git a/man/get_qualite_rivieres.Rd b/man/get_qualite_rivieres.Rd index 57096eb..41d79e3 100644 --- a/man/get_qualite_rivieres.Rd +++ b/man/get_qualite_rivieres.Rd @@ -35,7 +35,7 @@ Available endpoints are: \itemize{ \item \code{get_qualite_rivieres_station} retrieves physico-chemical measuring stations \item \code{get_qualite_rivieres_operation} retrieves physico-chemical operations -\item \code{get_qualite_rivieres_analyse} retrieves physico-chemical analysis +\item \code{get_qualite_rivieres_analyse} retrieves physico-chemical analyses \item \code{get_qualite_rivieres_condition_environnementale} retrieves physico-chemical environmental conditions for analyses (please note that pagination is based on the number of analyses) diff --git a/man/hubeau.Rd b/man/hubeau.Rd index 96cc42f..c2d3ad1 100644 --- a/man/hubeau.Rd +++ b/man/hubeau.Rd @@ -92,6 +92,19 @@ conclusions from the sanitary control of the distributed water commune by commun } } +\subsection{API "Qualité des cours d'eau"}{ + +API documentation: \url{https://hubeau.eaufrance.fr/page/api-qualite-cours-deau} + +Available functions: +\itemize{ +\item \code{\link[=get_qualite_rivieres_station]{get_qualite_rivieres_station()}}: measuring stations for river quality +\item \code{\link[=get_qualite_rivieres_operation]{get_qualite_rivieres_operation()}}: physico-chemical operations +\item \code{\link[=get_qualite_rivieres_analyse]{get_qualite_rivieres_analyse()}}: results of physico-chemical analyses +\item \code{\link[=get_qualite_rivieres_condition_environnementale]{get_qualite_rivieres_condition_environnementale()}}: environmental conditions for analyses +} +} + \subsection{API "Qualité des nappes d'eau souterraines"}{ API documentation: \url{https://hubeau.eaufrance.fr/page/api-qualite-nappes}