diff --git a/R/get_hydrometrie_stations.R b/R/get_hydrometrie_stations.R index d00b0f773fab2f908da51f703868d7d01a92e4e7..ec429995f2de3aa119e28243449c445685846803 100644 --- a/R/get_hydrometrie_stations.R +++ b/R/get_hydrometrie_stations.R @@ -9,9 +9,12 @@ #' @export #' #' @examples +#' \dontrun{ +#' # This function is temporarily unavailable because of https://github.com/BRGM/hubeau/issues/85 +#' #' # 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", package = "hubeau"))) { l <- doApiQuery(api = "hydrometrie", diff --git a/man/get_hydrometrie_observations_tr.Rd b/man/get_hydrometrie_observations_tr.Rd index 32e21a846a33201e566413a82cf6994982e4f888..fe14c5fedf65a6fd0b5817f4a970b72a24b98c11 100644 --- a/man/get_hydrometrie_observations_tr.Rd +++ b/man/get_hydrometrie_observations_tr.Rd @@ -20,6 +20,7 @@ configuration} } \value{ a \link[tibble:tibble]{tibble::tibble} with all available parameters in columns and one row by time step and by station. +If the query returns no records then the returned value is \link{NULL}. } \description{ See the API documentation for available filter parameters: \url{https://hubeau.eaufrance.fr/page/api-hydrometrie} diff --git a/man/get_hydrometrie_stations.Rd b/man/get_hydrometrie_stations.Rd index d4c677f0f2ee2e5a1d9bbe565d29af3cdfbf4829..5bd19f91c845c525b4df6ac674971a713c3e9ea6 100644 --- a/man/get_hydrometrie_stations.Rd +++ b/man/get_hydrometrie_stations.Rd @@ -25,7 +25,10 @@ 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{ +\dontrun{ +# This function is temporarily unavailable because of https://github.com/BRGM/hubeau/issues/85 + # Retrieve the hydrometric stations in the department of Aube get_hydrometrie_stations(list(code_departement = "10")) - +} }