docs

ropensci · Sep 23, 2024 · 0d94747 · 0d94747
1 parent d99f1c7
commit 0d94747
Show file tree

Hide file tree

Showing 43 changed files with 709 additions and 137 deletions.
diff --git a/R/tar_rep.R b/R/tar_rep.R
@@ -56,9 +56,9 @@
 #'   to run the command multiple times.
 #'   If the command returns a list or data frame, then
 #'   the targets from `tar_rep()` will try to append new elements/columns
-#'   `tar_batch` and `tar_rep` to the output
-#'   to denote the batch and rep-within-batch IDs, respectively.
-#'   See the "Target objects" section for background.
+#'   `tar_batch`, `tar_rep`, and `tar_seed` to the output
+#'   to denote the batch, rep-within-batch ID, and random number
+#'   generator seed, respectively.
 #'
 #'   `tar_read(your_target)` (on the downstream target with the actual work)
 #'   will return a list of lists, where the outer list has one element per

diff --git a/R/tar_rep_raw.R b/R/tar_rep_raw.R
@@ -20,10 +20,21 @@
 #'   are aggregated with `list()`. If `"vector"`,
 #'   then `vctrs::vec_c()`. If `"group"`, then `vctrs::vec_rbind()`.
 #' @inheritSection tar_rep Replicate-specific seeds
-#' @return A list of two target objects, one upstream and one downstream.
-#'   The upstream one does some work and returns some file paths,
-#'   and the downstream target is a pattern that applies `format = "file"`.
-#'   See the "Target objects" section for background.
+#' @return A list of two targets, one upstream and one downstream.
+#'   The upstream target returns a numeric index of batch ids,
+#'   and the downstream one dynamically maps over the batch ids
+#'   to run the command multiple times.
+#'   If the command returns a list or data frame, then
+#'   the targets from `tar_rep()` will try to append new elements/columns
+#'   `tar_batch`, `tar_rep`, and `tar_seed` to the output
+#'   to denote the batch, rep-within-batch ID, and random number
+#'   generator seed, respectively.
+#'
+#'   `tar_read(your_target)` (on the downstream target with the actual work)
+#'   will return a list of lists, where the outer list has one element per
+#'   batch and each inner list has one element per rep within batch.
+#'   To un-batch this nested list, call
+#'   `tar_read(your_target, recursive = FALSE)`.
 #' @inheritSection tar_map Target objects
 #' @inheritParams targets::tar_target_raw
 #' @inheritParams tar_rep

diff --git a/man/tar_age.Rd b/man/tar_age.Rd
diff --git a/man/tar_change.Rd b/man/tar_change.Rd
diff --git a/man/tar_combine.Rd b/man/tar_combine.Rd
diff --git a/man/tar_combine_raw.Rd b/man/tar_combine_raw.Rd
diff --git a/man/tar_download.Rd b/man/tar_download.Rd
diff --git a/man/tar_file_read.Rd b/man/tar_file_read.Rd
diff --git a/man/tar_files.Rd b/man/tar_files.Rd
diff --git a/man/tar_files_input.Rd b/man/tar_files_input.Rd
diff --git a/man/tar_files_input_raw.Rd b/man/tar_files_input_raw.Rd