Commit a26c354f authored by Dorchies David's avatar Dorchies David
Browse files

doc: comments in examples

parent f62d4134
No related merge requests found
Showing with 16 additions and 16 deletions
+16 -16
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
#' @export #' @export
#' #'
#' @examples #' @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(list(code_entite = "H0203020", grandeur_hydro = "Q"))
#' #'
get_hydrometrie_observations_tr <- function(params, get_hydrometrie_observations_tr <- function(params,
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
#' @export #' @export
#' #'
#' @examples #' @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")) #' get_hydrometrie_sites(list(code_departement = "10"))
#' #'
#' # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations #' # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
#' @export #' @export
#' #'
#' @examples #' @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(list(code_departement = "10"))
#' #'
get_hydrometrie_stations <- function(params, code_sandre_reseau_station = FALSE, cfg = config::get(file = system.file("config.yml", get_hydrometrie_stations <- function(params, code_sandre_reseau_station = FALSE, cfg = config::get(file = system.file("config.yml",
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
#' @export #' @export
#' #'
#' @examples #' @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(list(code_commune = "10323"))
#' #'
get_indicateurs_services_communes <- function(params, get_indicateurs_services_communes <- function(params,
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
#' @export #' @export
#' #'
#' @examples #' @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(list(code_indicateur = "D102.0", annee = "2012"))
#' #'
get_indicateurs_services_indicateurs <- function(params, get_indicateurs_services_indicateurs <- function(params,
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
#' @export #' @export
#' #'
#' @examples #' @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(list(code_commune_insee = "10323"))
#' #'
get_prelevements_chroniques <- function(params, cfg = config::get(file = system.file("config.yml", get_prelevements_chroniques <- function(params, cfg = config::get(file = system.file("config.yml",
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
#' @export #' @export
#' #'
#' @examples #' @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(list(code_commune_insee = "10323"))
#' #'
get_prelevements_ouvrages <- function(params, cfg = config::get(file = system.file("config.yml", get_prelevements_ouvrages <- function(params, cfg = config::get(file = system.file("config.yml",
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
#' @export #' @export
#' #'
#' @examples #' @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(list(code_commune_insee = "10323"))
#' #'
get_prelevements_points_prelevement <- function(params, cfg = config::get(file = system.file("config.yml", get_prelevements_points_prelevement <- function(params, cfg = config::get(file = system.file("config.yml",
......
...@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
} }
\examples{ \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(list(code_entite = "H0203020", grandeur_hydro = "Q"))
} }
...@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
} }
\examples{ \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")) get_hydrometrie_sites(list(code_departement = "10"))
# The same operation returning 2 rows for the site 'H0203020' which has 2 different locations # The same operation returning 2 rows for the site 'H0203020' which has 2 different locations
......
...@@ -25,7 +25,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie}
} }
\examples{ \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(list(code_departement = "10"))
} }
...@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
} }
\examples{ \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(list(code_commune = "10323"))
} }
...@@ -29,7 +29,7 @@ a \link[tibble:tibble]{tibble::tibble} with one row by commune, by service and b ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-indicateurs-services}
} }
\examples{ \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(list(code_indicateur = "D102.0", annee = "2012"))
} }
...@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
} }
\examples{ \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(list(code_commune_insee = "10323"))
} }
...@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau}
} }
\examples{ \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(list(code_commune_insee = "10323"))
} }
...@@ -22,7 +22,7 @@ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns ...@@ -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} See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-prelevements-eau#/prelevements/prelevement}
} }
\examples{ \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(list(code_commune_insee = "10323"))
} }
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment