Commit 896a0e04 authored by Dorchies David's avatar Dorchies David
Browse files

ci(docs): Disable example `get_hydrometrie_stations`

parent 123a2f05
Pipeline #30356 passed with stages
in 1 minute and 38 seconds
......@@ -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",
......
......@@ -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}
......
......@@ -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"))
}
}
Markdown is supported
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