From a66afa2c1c91ec59c886dcfc2076ac0306a03146 Mon Sep 17 00:00:00 2001 From: David Dorchies <14124454+DDorch@users.noreply.github.com> Date: Thu, 22 Feb 2024 14:56:30 +0100 Subject: [PATCH] docs(README): update description of API qualite_rivieres Refs #9 --- README.md | 12 ++++++++---- man-roxygen/hubeau.md | 8 ++++---- man/hubeau.Rd | 8 ++++---- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b631573..32957ff 100644 --- a/README.md +++ b/README.md @@ -154,13 +154,17 @@ API documentation: Available functions: - [`get_qualite_rivieres_station`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): - measuring stations for river quality + stations (measuring points) on rivers or water bodies where water + samples have been taken for water quality analyses - [`get_qualite_rivieres_operation`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): - physico-chemical operations + sampling operations carried out at the stations - [`get_qualite_rivieres_analyse`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): - results of physico-chemical analyses + physico-chemical analyses carried out on samples prepared during + sampling operations at the stations - [`get_qualite_rivieres_condition_environnementale`](https://inrae.github.io/hubeau/reference/get_qualite_rivieres.html): - environmental conditions for analyses + environmental conditions (air temperature, presence of leaves, moss, + iridescence, etc.) observed during physico-chemical sampling + operations ## API “Qualité des nappes d’eau souterraines” diff --git a/man-roxygen/hubeau.md b/man-roxygen/hubeau.md index 1e0ea04..ca6c926 100644 --- a/man-roxygen/hubeau.md +++ b/man-roxygen/hubeau.md @@ -82,10 +82,10 @@ 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 +- [get_qualite_rivieres_station()]: stations (measuring points) on rivers or water bodies where water samples have been taken for water quality analyses +- [get_qualite_rivieres_operation()]: sampling operations carried out at the stations +- [get_qualite_rivieres_analyse()]: physico-chemical analyses carried out on samples prepared during sampling operations at the stations +- [get_qualite_rivieres_condition_environnementale()]: environmental conditions (air temperature, presence of leaves, moss, iridescence, etc.) observed during physico-chemical sampling operations ## API "Qualité des nappes d'eau souterraines" diff --git a/man/hubeau.Rd b/man/hubeau.Rd index 59799cd..c90dbf1 100644 --- a/man/hubeau.Rd +++ b/man/hubeau.Rd @@ -101,10 +101,10 @@ 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 +\item \code{\link[=get_qualite_rivieres_station]{get_qualite_rivieres_station()}}: stations (measuring points) on rivers or water bodies where water samples have been taken for water quality analyses +\item \code{\link[=get_qualite_rivieres_operation]{get_qualite_rivieres_operation()}}: sampling operations carried out at the stations +\item \code{\link[=get_qualite_rivieres_analyse]{get_qualite_rivieres_analyse()}}: physico-chemical analyses carried out on samples prepared during sampling operations at the stations +\item \code{\link[=get_qualite_rivieres_condition_environnementale]{get_qualite_rivieres_condition_environnementale()}}: environmental conditions (air temperature, presence of leaves, moss, iridescence, etc.) observed during physico-chemical sampling operations } }