added documentation and some examples for tar_terra_rast/vect

NAMESPACE

@@ -1,4 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
 export(tar_terra_rast)
+export(tar_terra_vect)
 importFrom(utils,globalVariables)

R/tar-terra-rast.R

@@ -1,9 +1,31 @@
+#' Targets format for terra rasters
+#'
+#' Provides targets format for `terra::rast`
+#'
+#' @inheritParams targets::tar_target
+#'
 #' @export
+#' @examples
+#' if (Sys.getenv("TAR_LONG_EXAMPLES") == "true") {
+#' targets::tar_dir({ # tar_dir() runs code from a temporary directory.
+#' library(geotargets)
+#' targets::tar_script({
+#'   list(
+#'       geotargets::tar_terra_rast(
+#'           test,
+#'           system.file("ex/elev.tif", package="terra") |> terra::rast()
+#'       )
+#'   )
+#'   })
+#'    targets::tar_make()
+#' x <- targets::tar_read(test)
+#' })
+#' }
 tar_terra_rast <- function(name,
                            command,
                            pattern = NULL,
-                           packages = targets::tar_option_get("packages"),
                            tidy_eval = targets::tar_option_get("tidy_eval"),
+                           packages = targets::tar_option_get("packages"),
                            library = targets::tar_option_get("library"),
                            repository = targets::tar_option_get("repository"),
                            iteration = targets::tar_option_get("iteration"),

R/tar-terra-vect.R

@@ -33,6 +33,13 @@ format_terra_vect_shapefile <- targets::tar_format(
   unmarshal = function(object) terra::unwrap(object)
 )
 
+#' Targets format for terra vectors
+#'
+#' Provides targets format for `terra::vect` objects
+#'
+#' @inheritParams targets::tar_target
+#'
+#' @export
 tar_terra_vect <- function(name,
                           command,
                           pattern = NULL,