diff --git a/R/get_hydrometrie_observations_tr.R b/R/get_hydrometrie_observations_tr.R index 6eaf4f2c704328a668f8db1134e98920660d93ed..5b5f262de98a000ee2dc9555e3b5370b982cebbb 100644 --- a/R/get_hydrometrie_observations_tr.R +++ b/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, diff --git a/R/get_hydrometrie_sites.R b/R/get_hydrometrie_sites.R index 99deb379fe87b65ac8da9bf898da996db4e0d59f..1dbc1f02237bea9fbcf6c8ceaea0fbc5a8746eed 100644 --- a/R/get_hydrometrie_sites.R +++ b/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 diff --git a/R/get_hydrometrie_stations.R b/R/get_hydrometrie_stations.R index fd4286adba169d4ee1bc25a73344c10e85b4c3fd..d00b0f773fab2f908da51f703868d7d01a92e4e7 100644 --- a/R/get_hydrometrie_stations.R +++ b/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", diff --git a/R/get_indicateurs_services_communes.R b/R/get_indicateurs_services_communes.R index 7cb17c8e07ba7f15bac3f96956c7fa686877b0eb..0353691e4c8f09cc2762b6f2becebf633ed5831d 100644 --- a/R/get_indicateurs_services_communes.R +++ b/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, diff --git a/R/get_indicateurs_services_indicateurs.R b/R/get_indicateurs_services_indicateurs.R index 675a06a5d07ff0fbd91ecfb6af754cf9478a1281..828fc161cfab8f566814ba7f1082d8a67f48f3fc 100644 --- a/R/get_indicateurs_services_indicateurs.R +++ b/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, diff --git a/R/get_prelevements_chroniques.R b/R/get_prelevements_chroniques.R index 9a7983f37fefebc54ae2b4fcd2ed6ef0aaac75e8..a94db6f0fbd40a0fca51c250d5089d7290956d64 100644 --- a/R/get_prelevements_chroniques.R +++ b/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", diff --git a/R/get_prelevements_ouvrages.R b/R/get_prelevements_ouvrages.R index 46c7e028add9b6f783e7709860e135db1d63d4c6..6d44579a186e6a6f0b21d795d9d4586f0a773296 100644 --- a/R/get_prelevements_ouvrages.R +++ b/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", diff --git a/R/get_prelevements_points_prelevement.R b/R/get_prelevements_points_prelevement.R index b23b31470a69a2572884b16d59d30d3458c212a6..c9d5c93f7deb0ccb9828fdd03d0d55a1465e921c 100644 --- a/R/get_prelevements_points_prelevement.R +++ b/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", diff --git a/man/get_hydrometrie_observations_tr.Rd b/man/get_hydrometrie_observations_tr.Rd index 2c90cd4cf63dd3d411ef68a7d52b3e67ea7eb591..03509ebcc7355380b85db08d3fe45d37855023c7 100644 --- a/man/get_hydrometrie_observations_tr.Rd +++ b/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")) } diff --git a/man/get_hydrometrie_sites.Rd b/man/get_hydrometrie_sites.Rd index 07086d2fe1361eef04a608c107816b6e5997e79a..61130ff5e9d44299540c35e8d5d4494804fd4354 100644 --- a/man/get_hydrometrie_sites.Rd +++ b/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 diff --git a/man/get_hydrometrie_stations.Rd b/man/get_hydrometrie_stations.Rd index 029f6b8ef77c8b8f52fbf13ec84d5b18d1f33ab8..d4c677f0f2ee2e5a1d9bbe565d29af3cdfbf4829 100644 --- a/man/get_hydrometrie_stations.Rd +++ b/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")) } diff --git a/man/get_indicateurs_services_communes.Rd b/man/get_indicateurs_services_communes.Rd index 6f2e463655c7c9f1f2257f63901b85d4edd4f440..04251fbd3ad3a341795717a0b30d3cbe4b34cceb 100644 --- a/man/get_indicateurs_services_communes.Rd +++ b/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")) } diff --git a/man/get_indicateurs_services_indicateurs.Rd b/man/get_indicateurs_services_indicateurs.Rd index 1c03ef9da0342097353a3ca08a828e5fda96e41c..9c96ae26315b139518fd356f6942ad8389fe91e6 100644 --- a/man/get_indicateurs_services_indicateurs.Rd +++ b/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")) } diff --git a/man/get_prelevements_chroniques.Rd b/man/get_prelevements_chroniques.Rd index 3fac8cd0f6c3862087a17fe0c0cf814fae488f1d..3f1b8ccdec0e7e0dc71b38e2e97c44c545ec1b63 100644 --- a/man/get_prelevements_chroniques.Rd +++ b/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")) } diff --git a/man/get_prelevements_ouvrages.Rd b/man/get_prelevements_ouvrages.Rd index 7925b6ade5179a54f09664037d7e0aeb8b8b4ae1..80f51d932686810f4202ab1fc2e0544223f63311 100644 --- a/man/get_prelevements_ouvrages.Rd +++ b/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")) } diff --git a/man/get_prelevements_points_prelevement.Rd b/man/get_prelevements_points_prelevement.Rd index efea333bd4f4adc3076da248349965e956a22024..3c76aac46226e87a508c6fa1c976574eeca9375a 100644 --- a/man/get_prelevements_points_prelevement.Rd +++ b/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")) }