From 896a0e047f3d7ab9fe5cf617ea8c73246100cfae Mon Sep 17 00:00:00 2001
From: Dorchies David <david.dorchies@inrae.fr>
Date: Thu, 23 Dec 2021 16:56:04 +0100
Subject: [PATCH] ci(docs): Disable example `get_hydrometrie_stations`
---
R/get_hydrometrie_stations.R | 5 ++++-
man/get_hydrometrie_observations_tr.Rd | 1 +
man/get_hydrometrie_stations.Rd | 5 ++++-
3 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/R/get_hydrometrie_stations.R b/R/get_hydrometrie_stations.R
index d00b0f7..ec42999 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 32e21a8..fe14c5f 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 d4c677f..5bd19f9 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"))
-
+}
}
--
GitLab