chore: last changes before release

.Rbuildignore

@@ -11,3 +11,4 @@
 ^dev$
 ^cran-comments\.md$
 ^CRAN-SUBMISSION$
+^revdep$

.gitignore

@@ -48,3 +48,4 @@ po/*~
 # RStudio Connect folder
 rsconnect/
 inst/doc
+revdep/

DESCRIPTION

@@ -9,8 +9,9 @@ Authors@R: c(
     person("Pascal", "Irz", , "[email protected]", role = "ctb"),
     person("Sébastien", "Grall", , "[email protected]", role = "ctb")
   )
-Description: Collection of functions to help retrieving data from 'Hub'Eau' the
-    free and public French National APIs on water <https://hubeau.eaufrance.fr/>.
+Description: Collection of functions to help retrieving data from
+    'Hub'Eau' the free and public French National APIs on water
+    <https://hubeau.eaufrance.fr/>.
 License: MIT + file LICENSE
 URL: https://inrae.github.io/hubeau/,
     https://github.com/inrae/hubeau#readme
@@ -34,10 +35,11 @@ Suggests:
     sf,
     spelling,
     testthat (>= 3.0.0)
+VignetteBuilder: 
+    knitr
 Config/testthat/edition: 3
 Encoding: UTF-8
+Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
-Language: en-US
-VignetteBuilder: knitr

NEWS.md

@@ -1,4 +1,4 @@
-# hubeau (development version)
+# hubeau 0.4.0
 
 New features
 ------------
@@ -7,6 +7,7 @@ New features
 * Add API "Température des cours d'eau" (#8)
 * Add API "Qualité des nappes d'eau souterraine" (#10)
 * Add API "Qualité de l'eau potable" (#5)
+* Add vignettes with example of use of APIs (#21)
 
 Bug fixes
 ---------

R/get_qualite_eau_potable.R

@@ -7,7 +7,7 @@
 #' directly upstream, and links between communes and distribution units.
 #' The elements made available in this dataset correspond to a compilation of
 #' analysis bulletins published online, commune by commune, on the website of
-#' the Ministry of Health: \url{http://eaupotable.sante.gouv.fr/}
+#' the Ministry of Health: \url{https://sante.gouv.fr/sante-et-environnement/eaux/eau}
 #'
 #' Available endpoints are:
 #'

cran-comments.md

@@ -1,21 +1,6 @@
 ## R CMD check results
 
-0 errors | 0 warnings | 1 note
+0 errors | 0 warnings | 0 note
 
-* This is a new release.
-
-Second submission attempt after the following comment:
-
-> Please use only undirected quotation marks in the description text. e.g. "Hub'Eau" --> 'Hub'Eau'
->
-> Please fix and resubmit.
-> 
-> Best,
-> Victoria Wimmer
-
-All "Hub'Eau" have been changed to 'Hub'Eau' in the description text and the documentation.
-
-Thansks for all :)
-
-Best Regards,
-David Dorchies
+* This is a new release with some general improvements, new implemented APIs, 
+and a vignette for an extended example of use

inst/WORDLIST

@@ -5,19 +5,20 @@ BNPE
 CMD
 Cofund
 DOI
+Des
 Ecoulement
 Etiage
 Hub'Eau
-Hub’Eau’
+Hub'Eau'
 Hub'eau
 Hydrobiologie
 Hydrométrie
 Ille
 Indicateurs
 JPI
 NAIADES
-Observatoire
 ONDE
+Observatoire
 Piézométrie
 Prélèvements
 Qualité
@@ -41,6 +42,7 @@ de
 departement
 des
 doApiQuery
+dplyr
 d’eau
 eau
 eaufrance
@@ -59,17 +61,21 @@ inrae
 insee
 io
 l'eau
+l’eau
 nappes
 nom
 numero
+openapi
 ouvrage
 piezometric
 piezometrie
 pkgdown
 poisson
 prelevements
 qualite
+souterraine
 souterraines
+th
 tibble
 uri
 usuelle

vignettes/example_ecoulement_api.Rmd

@@ -121,8 +121,10 @@ mapview::mapview(
 
 ## Surveys
 
-A survey encompasses a series of visual observations carried out  on stations at the "departement" grain. 
-It is tagged as "usuelle" if it is a routine (i.e. around the 24th of the month from May to September), as "complémentaire" if not (e.g. during very dry periods).
+A survey encompasses a series of visual observations carried out on stations at 
+the "departement" grain. 
+It is tagged as "usuelle" if it is a routine (i.e. around the 24th of the month 
+from May to September), as "complémentaire" if not (e.g. during very dry periods).
 
 Download the `surveys` dataframe.