Merge pull request #85 from njtierney/iteration-list

Hard code `iteration = "list"`
njtierney · Aug 19, 2024 · ea1f9fe · ea1f9fe
2 parents 1be6d62 + 76ae2e8
commit ea1f9fe
Show file tree

Hide file tree

Showing 14 changed files with 109 additions and 94 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -30,7 +30,7 @@ License: MIT + file LICENSE
 Encoding: UTF-8
 Language: en-GB
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 Imports: 
     targets (>= 1.7.0),
     rlang (>= 1.1.3),

diff --git a/NEWS.md b/NEWS.md
@@ -2,6 +2,7 @@
 
 * Created `tar_stars()` and `tar_stars_proxy()` that create `stars` and `stars_proxy` objects, respectively.
 * Created `tar_terra_tiles()`, a "target factory" for splitting a raster into multiple tiles with dynamic branching.
+* Removes the `iteration` argument from all `tar_*()` functions.  `iteration` now hard-coded as `"list"` since it is the only option that works (for now at least).
 * Created two helper functions for use in `tar_terra_tiles()`: `tile_grid()` and `tile_blocksize()`.
 * Created utility function `set_window()` mostly for internal use within `tar_terra_tiles()`.
 * Added the `description` argument to all `tar_*()` functions which is passed to `tar_target()`.

diff --git a/R/tar-stars.R b/R/tar-stars.R
@@ -10,6 +10,10 @@
 #' @param ... Additional arguments not yet used
 #'
 #' @inheritParams targets::tar_target
+#'
+#' @note The `iteration` argument is unavailable because it is hard-coded to
+#'   `"list"`, the only option that works currently.
+#'
 #' @seealso [targets::tar_target_raw()]
 #' @export
 #' @examplesIf rlang::is_installed("stars")
@@ -41,7 +45,6 @@ tar_stars <- function(name,
                       packages = targets::tar_option_get("packages"),
                       library = targets::tar_option_get("library"),
                       repository = targets::tar_option_get("repository"),
-                      iteration = targets::tar_option_get("iteration"),
                       error = targets::tar_option_get("error"),
                       memory = targets::tar_option_get("memory"),
                       garbage_collection = targets::tar_option_get("garbage_collection"),
@@ -83,7 +86,6 @@ tar_stars <- function(name,
         packages = packages,
         library = library,
         repository = repository,
-        iteration = iteration,
         error = error,
         memory = memory,
         garbage_collection = garbage_collection,
@@ -111,7 +113,6 @@ tar_stars_proxy <- function(name,
                             packages = targets::tar_option_get("packages"),
                             library = targets::tar_option_get("library"),
                             repository = targets::tar_option_get("repository"),
-                            iteration = targets::tar_option_get("iteration"),
                             error = targets::tar_option_get("error"),
                             memory = targets::tar_option_get("memory"),
                             garbage_collection = targets::tar_option_get("garbage_collection"),
@@ -154,7 +155,6 @@ tar_stars_proxy <- function(name,
         packages = packages,
         library = library,
         repository = repository,
-        iteration = iteration,
         error = error,
         memory = memory,
         garbage_collection = garbage_collection,
@@ -184,7 +184,6 @@ tar_stars_raw <- function(name,
                           packages = targets::tar_option_get("packages"),
                           library = targets::tar_option_get("library"),
                           repository = targets::tar_option_get("repository"),
-                          iteration = targets::tar_option_get("iteration"),
                           error = targets::tar_option_get("error"),
                           memory = targets::tar_option_get("memory"),
                           garbage_collection = targets::tar_option_get("garbage_collection"),
@@ -264,7 +263,7 @@ tar_stars_raw <- function(name,
             unmarshal = function(object) object
         ),
         repository = repository,
-        iteration = iteration,
+        iteration = "list", #the only option that works
         error = error,
         memory = memory,
         garbage_collection = garbage_collection,

diff --git a/R/tar-terra-rast.R b/R/tar-terra-rast.R
@@ -9,6 +9,10 @@
 #' @param ... Additional arguments not yet used
 #'
 #' @inheritParams targets::tar_target
+#'
+#' @note The `iteration` argument is unavailable because it is hard-coded to
+#'   `"list"`, the only option that works currently.
+#'
 #' @returns target class "tar_stem" for use in a target pipeline
 #' @importFrom rlang %||% arg_match0
 #' @seealso [targets::tar_target_raw()]
@@ -39,7 +43,6 @@ tar_terra_rast <- function(name,
                            packages = targets::tar_option_get("packages"),
                            library = targets::tar_option_get("library"),
                            repository = targets::tar_option_get("repository"),
-                           iteration = targets::tar_option_get("iteration"),
                            error = targets::tar_option_get("error"),
                            memory = targets::tar_option_get("memory"),
                            garbage_collection = targets::tar_option_get("garbage_collection"),
@@ -104,7 +107,7 @@ tar_terra_rast <- function(name,
             unmarshal = function(object) terra::unwrap(object)
         ),
         repository = repository,
-        iteration = iteration,
+        iteration = "list", #only "list" works right now
         error = error,
         memory = memory,
         garbage_collection = garbage_collection,

diff --git a/R/tar-terra-sprc.R b/R/tar-terra-sprc.R
@@ -10,6 +10,10 @@
 #' @param ... Additional arguments not yet used
 #'
 #' @inheritParams targets::tar_target
+#'
+#' @note The `iteration` argument is unavailable because it is hard-coded to
+#'   `"list"`, the only option that works currently.
+#'
 #' @returns target class "tar_stem" for use in a target pipeline
 #' @seealso [targets::tar_target_raw()]
 #' @author Andrew Gene Brown
@@ -52,7 +56,6 @@ tar_terra_sprc <- function(name,
                            packages = targets::tar_option_get("packages"),
                            library = targets::tar_option_get("library"),
                            repository = targets::tar_option_get("repository"),
-                           iteration = targets::tar_option_get("iteration"),
                            error = targets::tar_option_get("error"),
                            memory = targets::tar_option_get("memory"),
                            garbage_collection = targets::tar_option_get("garbage_collection"),
@@ -123,7 +126,7 @@ tar_terra_sprc <- function(name,
         unmarshal = function(object) terra::unwrap(object)
     ),
     repository = repository,
-    iteration = iteration,
+    iteration = "list",
     error = error,
     memory = memory,
     garbage_collection = garbage_collection,

diff --git a/R/tar-terra-vect.R b/R/tar-terra-vect.R
@@ -8,6 +8,10 @@
 #'   passed to [terra::writeVector()].
 #' @param ... Additional arguments not yet used
 #' @inheritParams targets::tar_target
+#'
+#' @note The `iteration` argument is unavailable because it is hard-coded to
+#'   `"list"`, the only option that works currently.
+#'
 #' @returns target class "tar_stem" for use in a target pipeline
 #'
 #' @note Although you may pass any supported GDAL vector driver to the
@@ -48,7 +52,6 @@ tar_terra_vect <- function(name,
                            tidy_eval = targets::tar_option_get("tidy_eval"),
                            library = targets::tar_option_get("library"),
                            repository = targets::tar_option_get("repository"),
-                           iteration = targets::tar_option_get("iteration"),
                            error = targets::tar_option_get("error"),
                            memory = targets::tar_option_get("memory"),
                            garbage_collection = targets::tar_option_get("garbage_collection"),
@@ -103,7 +106,7 @@ tar_terra_vect <- function(name,
         library = library,
         format = format,
         repository = repository,
-        iteration = iteration,
+        iteration = "list",  #only "list" works for now
         error = error,
         memory = memory,
         garbage_collection = garbage_collection,

diff --git a/R/tar_terra_tiles.R b/R/tar_terra_tiles.R
@@ -17,6 +17,9 @@
 #' @inheritParams targets::tar_target
 #' @author Eric Scott
 #'
+#' @note The `iteration` argument is unavailable because it is hard-coded to
+#'   `"list"`, the only option that works currently.
+#'
 #' @return a list of two targets: an upstream target that creates a list of
 #'   extents and a downstream pattern that maps over these extents to create a
 #'   list of SpatRaster objects.

diff --git a/man/tar_stars.Rd b/man/tar_stars.Rd
diff --git a/man/tar_terra_rast.Rd b/man/tar_terra_rast.Rd
diff --git a/man/tar_terra_sprc.Rd b/man/tar_terra_sprc.Rd
diff --git a/man/tar_terra_tiles.Rd b/man/tar_terra_tiles.Rd
diff --git a/man/tar_terra_vect.Rd b/man/tar_terra_vect.Rd
diff --git a/tests/testthat/test-tar-stars.R b/tests/testthat/test-tar-stars.R
@@ -78,3 +78,25 @@ targets::tar_test("tar_stars(mdim=TRUE, ncdf=TRUE) works", {
   expect_s3_class(x, "stars")
   expect_snapshot(x)
 })
+
+targets::tar_test("tar_stars() works with dynamic branching", {
+    targets::tar_script({
+        list(
+            geotargets::tar_stars(
+                test_stars,
+                stars::read_stars(system.file("tif", "olinda_dem_utm25s.tif", package = "stars"))
+            ),
+            targets::tar_target(
+                to_add,
+                c(1,2)
+            ),
+            geotargets::tar_stars(
+                test_stars_plus,
+                test_stars + to_add,
+                pattern = map(to_add)
+            )
+        )
+    })
+    targets::tar_make()
+    expect_length(targets::tar_read(test_stars_plus), 2)
+})