doc: comments in examples

R/get_hydrometrie_observations_tr.R

@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the hydrometric last real time observed discharge at station 'H020302002'
+#' # Retrieve the hydrometric last real time observed discharge at station 'H020302002'
 #' get_hydrometrie_observations_tr(list(code_entite = "H0203020", grandeur_hydro = "Q"))
 #'
 get_hydrometrie_observations_tr  <- function(params,

R/get_hydrometrie_sites.R

@@ -9,7 +9,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the hydrometric sites in the department of Aube
+#' # Retrieve the hydrometric sites in the department of Aube
 #' get_hydrometrie_sites(list(code_departement = "10"))
 #'
 #' # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations

R/get_hydrometrie_stations.R

@@ -9,7 +9,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the hydrometric stations in the department of Aube
+#' # Retrieve the hydrometric stations in the department of Aube
 #' get_hydrometrie_stations(list(code_departement = "10"))
 #'
 get_hydrometrie_stations  <- function(params, code_sandre_reseau_station = FALSE, cfg = config::get(file = system.file("config.yml",

R/get_indicateurs_services_communes.R

@@ -15,7 +15,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving performance indicator time series of the services in Romilly-sur-Seine
+#' # Retrieve performance indicator time series of the services in Romilly-sur-Seine
 #' get_indicateurs_services_communes(list(code_commune = "10323"))
 #'
 get_indicateurs_services_communes <- function(params,

R/get_indicateurs_services_indicateurs.R

@@ -15,7 +15,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+#' # Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 #' get_indicateurs_services_indicateurs(list(code_indicateur = "D102.0", annee = "2012"))
 #'
 get_indicateurs_services_indicateurs <- function(params,

R/get_prelevements_chroniques.R

@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+#' # Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 #' get_prelevements_chroniques(list(code_commune_insee = "10323"))
 #'
 get_prelevements_chroniques <- function(params, cfg = config::get(file = system.file("config.yml",

R/get_prelevements_ouvrages.R

@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal devices located in Romilly-sur-Seine
+#' # Retrieve the withdrawal devices located in Romilly-sur-Seine
 #' get_prelevements_ouvrages(list(code_commune_insee = "10323"))
 #'
 get_prelevements_ouvrages <- function(params, cfg = config::get(file = system.file("config.yml",

R/get_prelevements_points_prelevement.R

@@ -8,7 +8,7 @@
 #' @export
 #'
 #' @examples
-#' # For retrieving the withdrawal points located in Romilly-sur-Seine
+#' # Retrieve the withdrawal points located in Romilly-sur-Seine
 #' get_prelevements_points_prelevement(list(code_commune_insee = "10323"))
 #'
 get_prelevements_points_prelevement <- function(params, cfg = config::get(file = system.file("config.yml",

man/get_hydrometrie_observations_tr.Rd

@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
 }
 \examples{
-# For retrieving the hydrometric last real time observed discharge at station 'H020302002'
+# Retrieve the hydrometric last real time observed discharge at station 'H020302002'
 get_hydrometrie_observations_tr(list(code_entite = "H0203020", grandeur_hydro = "Q"))
 
 }

man/get_hydrometrie_sites.Rd

@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
 }
 \examples{
-# For retrieving the hydrometric sites in the department of Aube
+# Retrieve the hydrometric sites in the department of Aube
 get_hydrometrie_sites(list(code_departement = "10"))
 
 # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations

man/get_hydrometrie_stations.Rd

@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
 }
 \examples{
-# For retrieving the hydrometric stations in the department of Aube
+# Retrieve the hydrometric stations in the department of Aube
 get_hydrometrie_stations(list(code_departement = "10"))
 
 }

man/get_indicateurs_services_communes.Rd

@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
 }
 \examples{
-# For retrieving performance indicator time series of the services in Romilly-sur-Seine
+# Retrieve performance indicator time series of the services in Romilly-sur-Seine
 get_indicateurs_services_communes(list(code_commune = "10323"))
 
 }

man/get_indicateurs_services_indicateurs.Rd

@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
 }
 \examples{
-# For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+# Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 get_indicateurs_services_indicateurs(list(code_indicateur = "D102.0", annee = "2012"))
 
 }

man/get_prelevements_chroniques.Rd

@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
 }
 \examples{
-# For retrieving the withdrawal time series of the devices located in Romilly-sur-Seine
+# Retrieve the withdrawal time series of the devices located in Romilly-sur-Seine
 get_prelevements_chroniques(list(code_commune_insee = "10323"))
 
 }

man/get_prelevements_ouvrages.Rd

@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
 }
 \examples{
-# For retrieving the withdrawal devices located in Romilly-sur-Seine
+# Retrieve the withdrawal devices located in Romilly-sur-Seine
 get_prelevements_ouvrages(list(code_commune_insee = "10323"))
 
 }

man/get_prelevements_points_prelevement.Rd

@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns
 See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau#/prelevements/prelevement}
 }
 \examples{
-# For retrieving the withdrawal points located in Romilly-sur-Seine
+# Retrieve the withdrawal points located in Romilly-sur-Seine
 get_prelevements_points_prelevement(list(code_commune_insee = "10323"))
 
 }