Merge pull request #43 from inrae/39-solve-warning-doctype-package-is…

…-deprecated 39 solve warning doctype package is deprecated
inrae · Feb 22, 2024 · f66262a · f66262a
2 parents 6839ea2 + f0cc3d7
commit f66262a
Show file tree

Hide file tree

Showing 7 changed files with 77 additions and 4 deletions.
diff --git 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/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/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:
+<https://hubeau.eaufrance.fr/page/api-qualite-cours-deau>
+
+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: <https://hubeau.eaufrance.fr/page/api-qualite-nappes>

diff --git 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: <https://hubeau.eaufrance.fr/page/api-qualite-cours-deau>
+
+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: <https://hubeau.eaufrance.fr/page/api-qualite-nappes>

diff --git a/man/get_qualite_rivieres.Rd b/man/get_qualite_rivieres.Rd
diff --git a/man/hubeau-package.Rd b/man/hubeau-package.Rd
diff --git a/man/hubeau.Rd b/man/hubeau.Rd