tar_format_get()

ropensci · Aug 28, 2024 · d7f4228 · d7f4228
1 parent 71d9b17
commit d7f4228
Show file tree

Hide file tree

Showing 22 changed files with 90 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -433,6 +433,7 @@ export(tar_exist_process)
 export(tar_exist_progress)
 export(tar_exist_script)
 export(tar_format)
+export(tar_format_get)
 export(tar_github_actions)
 export(tar_glimpse)
 export(tar_group)

diff --git a/NEWS.md b/NEWS.md
@@ -11,6 +11,7 @@
 * Implement `format = "auto"` (#1311, @hadley).
 * Replace `pingr` dependency with `base::socketConnection()` for local URL utilities (#1317, #1318, @Adafede).
 * Implement `tar_repository_cas()`, `tar_repository_cas_local()`, and `tar_repository_cas_local_gc()` for content-addressable storage (#1232, #1314, @noamross).
+* Add `tar_format_get()` to make implementing CAS systems easier.
 
 # targets 1.7.1
 

diff --git a/R/tar_format_get.R b/R/tar_format_get.R
@@ -0,0 +1,17 @@
+#' @title Current storage format.
+#' @export
+#' @family utilities
+#' @description Get the storage format of the target currently running.
+#' @details This function is meant to be called inside a target in a
+#'   running pipeline. If it is called outside a target in the running
+#'   pipeline, it will return the default format given by
+#'   `tar_option_get("format")`.
+#' @return A character string, storage format of the target currently
+#'   running in the pipeline. If called outside a target in the running
+#'   pipeline, [tar_format_get()] will return the default format given by
+#'   `tar_option_get("format")`.
+#' @examples
+#' tar_target(x, tar_format_get(), format = "qs")
+tar_format_get <- function() {
+  tar_definition()$settings$format
+}
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -172,6 +172,7 @@ reference:
   - 'tar_definition'
   - 'tar_described_as'
   - 'tar_envir'
+  - 'tar_format_get'
   - 'tar_group'
   - 'tar_name'
   - 'tar_path_script'

diff --git a/man/tar_active.Rd b/man/tar_active.Rd
diff --git a/man/tar_backoff.Rd b/man/tar_backoff.Rd
diff --git a/man/tar_call.Rd b/man/tar_call.Rd
diff --git a/man/tar_cancel.Rd b/man/tar_cancel.Rd
diff --git a/man/tar_definition.Rd b/man/tar_definition.Rd
diff --git a/man/tar_described_as.Rd b/man/tar_described_as.Rd
diff --git a/man/tar_envir.Rd b/man/tar_envir.Rd
diff --git a/man/tar_format_get.Rd b/man/tar_format_get.Rd
diff --git a/man/tar_group.Rd b/man/tar_group.Rd
diff --git a/man/tar_name.Rd b/man/tar_name.Rd
diff --git a/man/tar_path.Rd b/man/tar_path.Rd
diff --git a/man/tar_path_script.Rd b/man/tar_path_script.Rd
diff --git a/man/tar_path_script_support.Rd b/man/tar_path_script_support.Rd
diff --git a/man/tar_path_store.Rd b/man/tar_path_store.Rd
diff --git a/man/tar_path_target.Rd b/man/tar_path_target.Rd
diff --git a/man/tar_source.Rd b/man/tar_source.Rd
diff --git a/man/tar_store.Rd b/man/tar_store.Rd
diff --git a/tests/testthat/test-tar_format_get.R b/tests/testthat/test-tar_format_get.R
@@ -0,0 +1,8 @@
+tar_test("tar_format_get()", {
+  skip_cran()
+  skip_if_not_installed("qs")
+  expect_equal(tar_format_get(), tar_option_get("format"))
+  tar_script(tar_target(x, tar_format_get(), format = "qs"))
+  tar_make(callr_function = NULL)
+  expect_equal(tar_read(x), "qs")
+})