docs

ropensci · Oct 12, 2023 · 5a53526 · 5a53526
1 parent a16e02c
commit 5a53526
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/R/tar_seed_create.R b/R/tar_seed_create.R
@@ -48,6 +48,13 @@
 #'        integer using `digest::digest2int()`. This is necessary
 #'        because integers in R can only be 32 bits. `set.seed()`
 #'        cannot accept anything greater.
+#' @return Integer of length 1, the target seed.
+#' @param name Character of length 1, target name.
+#' @param global_seed Integer of length 1, the overarching global
+#'   pipeline seed which governs the seeds of all the targets.
+#'   Set to `NULL` to default to `tar_option_get("seed")`.
+#'   Set to `NA` to disable seed setting in `targets` and make
+#'   [tar_seed_create()] return `NA_integer_`.
 #' @references
 #'   Pierre L'Ecuyer, David Munger, Boris Oreshkin, and Richard Simard
 #'   (2017). Random numbers for parallel computers: Requirements and methods,

diff --git a/R/tar_seed_set.R b/R/tar_seed_set.R
@@ -18,7 +18,7 @@
 #' @param seed Integer of length 1, value of the seed to set
 #'   with `set.seed()`.
 #' @examples
-#' seed <- tar_seed_create()
+#' seed <- tar_seed_create("target_name")
 #' seed
 #' sample(10)
 #' tar_seed_set(seed)

diff --git a/man/tar_seed_create.Rd b/man/tar_seed_create.Rd
diff --git a/man/tar_seed_set.Rd b/man/tar_seed_set.Rd