docs: terra examples fix

atsyplenkov · Jan 4, 2025 · f84e89d · f84e89d · github-actions · Jan 4, 2025
1 parent f914fe8
commit f84e89d
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 18 deletions.
diff --git a/R/conversion.R b/R/conversion.R
@@ -92,12 +92,13 @@ S7::method(wbw_to_degrees, WhiteboxRaster) <-
 #'
 #' @seealso [WhiteboxRaster()]
 #'
-#' @examplesIf requireNamespace("terra", quietly = TRUE)
+#' @examples
+#' \dontrun{
 #' f <- system.file("extdata/dem.tif", package = "wbw")
 #' wbw_read_raster(f) |>
 #'   wbw_slope(units = "r") |>
 #'   as_rast()
-#'
+#' }
 #' @export
 as_rast <-
   S7::new_generic(
@@ -168,12 +169,13 @@ S7::method(as_rast, WhiteboxRaster) <-
 #'
 #' @seealso [WhiteboxRaster()]
 #'
-#' @examplesIf requireNamespace("terra", quietly = TRUE)
+#' @examples
+#' \dontrun{
 #' library(terra)
 #' f <- system.file("extdata/dem.tif", package = "wbw")
 #' rast(f) |>
 #'   as_wbw_raster()
-#'
+#' }
 #' @export
 as_wbw_raster <-
   S7::new_generic(

diff --git a/R/math.R b/R/math.R
@@ -22,7 +22,7 @@
 #' @return [WhiteboxRaster] object
 #'
 #' @eval rd_wbw_link("random_sample")
-#' @eval rd_example("random_sample", c("num_samples = 100"))
+#' @eval rd_example("wbw_random_sample", c("num_samples = 100"))
 #'
 #' @export
 wbw_random_sample <-

diff --git a/R/read.R b/R/read.R
@@ -11,10 +11,8 @@
 #' @return WhiteboxRaster object
 #'
 #' @examples
-#' \dontrun{
-#' raster_path <- system.file("extdata/dem.tif", package = "wbw")
-#' wbw_read_raster(raster_path)
-#' }
+#' f <- system.file("extdata/dem.tif", package = "wbw")
+#' wbw_read_raster(f)
 #'
 #' @export
 wbw_read_raster <- function(file_name) {

diff --git a/man/as_rast.Rd b/man/as_rast.Rd
diff --git a/man/as_wbw_raster.Rd b/man/as_wbw_raster.Rd
diff --git a/man/io.Rd b/man/io.Rd
diff --git a/man/wbw_random_sample.Rd b/man/wbw_random_sample.Rd