doc(*): examples

DESCRIPTION

@@ -1,10 +1,10 @@
 Package: EGLVgauges
 Title: R Interface for data acquisition from pegel.eglv.de
-Version: 0.2.3
+Version: 0.2.4
 Date: 2024-12-26
 Authors@R: 
     person("Dimitri", "Falk", , "[email protected]", role = c("aut", "cre"))
-Description: What the package does (one paragraph).
+Description: Grants easy access to EGLV gauge data and metadata.
 License: AGPL (>= 3)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

R/get_gauges.R

@@ -4,7 +4,9 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' get_gauges()
+#' }
 get_gauges <- function() {
 
   # debugging ------------------------------------------------------------------

R/get_measurements.R

@@ -9,6 +9,7 @@
 #' @seealso [get_gauges()]
 #'
 #' @examples
+#' \dontrun{
 #' gauge <- get_gauges() |> dplyr::filter(id == "10103")
 #'
 #' get_measurements(gauge)
@@ -17,6 +18,7 @@
 #' gauges <- get_gauges() |> dplyr::filter(waterbody == "Hammbach")
 #'
 #' get_measurements(gauges)
+#' }
 get_measurements <- function(x = NULL,
                              discharge = FALSE) {
 

R/get_meta.R

@@ -8,11 +8,13 @@
 #' @seealso [get_gauges()]
 #'
 #' @examples
+#' \dontrun{
 #' gauge <- get_gauges() |> dplyr::filter(id == "10103")
 #' get_meta(gauge)
 #'
 #' gauges <- get_gauges() |> dplyr::filter(waterbody == "Hammbach")
 #' get_meta(gauges)
+#' }
 get_meta <- function(x = NULL) {
 
   # debugging ------------------------------------------------------------------