diff --git a/NEWS.md b/NEWS.md index 57f231c..205eca2 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,8 @@ -# tarchetypes 0.10.0.9002 (development) +# tarchetypes 0.10.0.9003 (development) * Add an `output_file` argument to `tar_quarto()` and `tar_quarto_raw()` for single documents (#198, @mutlusun). * Detect child quarto documents (#199, @mutlusun). +* Improve reporting of static branch names from `tar_map()` and `tar_map_rep()` (#201, @kkmann). # tarchetypes 0.10.0 diff --git a/R/tar_map.R b/R/tar_map.R index b93988e..7b20da7 100644 --- a/R/tar_map.R +++ b/R/tar_map.R @@ -143,7 +143,7 @@ tar_map_default_suffixes <- function(values) { } tar_map_target <- function(target, values, descriptions) { - lapply( + out <- lapply( X = transpose(values), FUN = tar_map_iter, target = target, @@ -151,6 +151,8 @@ tar_map_target <- function(target, values, descriptions) { pattern = target$settings$pattern, descriptions = descriptions ) + names(out) <- map_chr(out, ~.x$settings$name) + out } tar_map_iter <- function(values, target, command, pattern, descriptions) { diff --git a/R/tar_map_rep.R b/R/tar_map_rep.R index fc54959..9481dc3 100644 --- a/R/tar_map_rep.R +++ b/R/tar_map_rep.R @@ -85,6 +85,7 @@ tar_map_rep <- function( rep_workers = 1, combine = TRUE, delimiter = "_", + unlist = FALSE, tidy_eval = targets::tar_option_get("tidy_eval"), packages = targets::tar_option_get("packages"), library = targets::tar_option_get("library"), @@ -113,6 +114,7 @@ tar_map_rep <- function( rep_workers = rep_workers, combine = combine, delimiter = delimiter, + unlist = unlist, tidy_eval = tidy_eval, packages = packages, library = library, diff --git a/R/tar_map_rep_raw.R b/R/tar_map_rep_raw.R index 591f7ef..4988cb7 100644 --- a/R/tar_map_rep_raw.R +++ b/R/tar_map_rep_raw.R @@ -12,6 +12,7 @@ tar_map_rep_raw <- function( rep_workers = 1, combine = TRUE, delimiter = "_", + unlist = FALSE, tidy_eval = targets::tar_option_get("tidy_eval"), packages = targets::tar_option_get("packages"), library = targets::tar_option_get("library"), @@ -117,9 +118,10 @@ tar_map_rep_raw <- function( values = values, names = names, descriptions = descriptions, - delimiter = delimiter + delimiter = delimiter, + unlist = unlist ) - ) + )[[1L]] ) target_combine <- if_any( is.null(values) || !combine, @@ -142,7 +144,15 @@ tar_map_rep_raw <- function( description = description ) ) - unlist(list(target_batch, target_static, target_combine), recursive = TRUE) + out <- list( + batch_index = target_batch, + static_branches = target_static, + combine = target_combine + ) + if (unlist) { + out <- unlist(out, recursive = TRUE) + } + out } tar_map_combine_command <- expression({ diff --git a/man/tar_age.Rd b/man/tar_age.Rd index 1759b18..8f8a598 100644 --- a/man/tar_age.Rd +++ b/man/tar_age.Rd @@ -129,8 +129,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_change.Rd b/man/tar_change.Rd index aa06ca9..bfcc353 100644 --- a/man/tar_change.Rd +++ b/man/tar_change.Rd @@ -89,7 +89,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -164,8 +164,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_combine.Rd b/man/tar_combine.Rd index d2bbda9..f58ec9c 100644 --- a/man/tar_combine.Rd +++ b/man/tar_combine.Rd @@ -114,7 +114,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -189,8 +189,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_download.Rd b/man/tar_download.Rd index 0563ed8..22d4df5 100644 --- a/man/tar_download.Rd +++ b/man/tar_download.Rd @@ -150,8 +150,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_file_read.Rd b/man/tar_file_read.Rd index 47f43fe..13c76a2 100644 --- a/man/tar_file_read.Rd +++ b/man/tar_file_read.Rd @@ -92,7 +92,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -148,8 +148,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_files.Rd b/man/tar_files.Rd index 38269c3..fd44ce8 100644 --- a/man/tar_files.Rd +++ b/man/tar_files.Rd @@ -93,7 +93,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -168,8 +168,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_files_input.Rd b/man/tar_files_input.Rd index 2e28580..8b4d935 100644 --- a/man/tar_files_input.Rd +++ b/man/tar_files_input.Rd @@ -73,7 +73,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -134,8 +134,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{priority}{Numeric of length 1 between 0 and 1. Controls which targets get deployed first when multiple competing targets are ready diff --git a/man/tar_force.Rd b/man/tar_force.Rd index de65c04..1651a5f 100644 --- a/man/tar_force.Rd +++ b/man/tar_force.Rd @@ -90,7 +90,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -165,8 +165,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_formats.Rd b/man/tar_formats.Rd index 37fcb88..842294f 100644 --- a/man/tar_formats.Rd +++ b/man/tar_formats.Rd @@ -360,7 +360,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -435,8 +435,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_formats_superseded.Rd b/man/tar_formats_superseded.Rd index 410a744..45a85c5 100644 --- a/man/tar_formats_superseded.Rd +++ b/man/tar_formats_superseded.Rd @@ -314,7 +314,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -389,8 +389,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_group_by.Rd b/man/tar_group_by.Rd index a5836d4..2915120 100644 --- a/man/tar_group_by.Rd +++ b/man/tar_group_by.Rd @@ -89,7 +89,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -145,8 +145,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_group_count.Rd b/man/tar_group_count.Rd index 1cfa11c..d4fff54 100644 --- a/man/tar_group_count.Rd +++ b/man/tar_group_count.Rd @@ -89,7 +89,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -145,8 +145,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_group_select.Rd b/man/tar_group_select.Rd index 7da0263..65508bb 100644 --- a/man/tar_group_select.Rd +++ b/man/tar_group_select.Rd @@ -90,7 +90,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -146,8 +146,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_group_size.Rd b/man/tar_group_size.Rd index 06e3961..5e76069 100644 --- a/man/tar_group_size.Rd +++ b/man/tar_group_size.Rd @@ -90,7 +90,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -146,8 +146,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_knit.Rd b/man/tar_knit.Rd index e8ae7d8..24d9d0d 100644 --- a/man/tar_knit.Rd +++ b/man/tar_knit.Rd @@ -126,8 +126,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_map2.Rd b/man/tar_map2.Rd index 78fa5b7..0cd850f 100644 --- a/man/tar_map2.Rd +++ b/man/tar_map2.Rd @@ -186,7 +186,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -242,8 +242,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_map2_count.Rd b/man/tar_map2_count.Rd index fd33f75..5017cc7 100644 --- a/man/tar_map2_count.Rd +++ b/man/tar_map2_count.Rd @@ -193,7 +193,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -249,8 +249,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_map2_size.Rd b/man/tar_map2_size.Rd index 33f8215..9f7dc4b 100644 --- a/man/tar_map2_size.Rd +++ b/man/tar_map2_size.Rd @@ -193,7 +193,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -249,8 +249,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_map_rep.Rd b/man/tar_map_rep.Rd index 9fe4635..90721c8 100644 --- a/man/tar_map_rep.Rd +++ b/man/tar_map_rep.Rd @@ -18,6 +18,7 @@ tar_map_rep( rep_workers = 1, combine = TRUE, delimiter = "_", + unlist = FALSE, tidy_eval = targets::tar_option_get("tidy_eval"), packages = targets::tar_option_get("packages"), library = targets::tar_option_get("library"), @@ -47,6 +48,7 @@ tar_map_rep_raw( rep_workers = 1, combine = TRUE, delimiter = "_", + unlist = FALSE, tidy_eval = targets::tar_option_get("tidy_eval"), packages = targets::tar_option_get("packages"), library = targets::tar_option_get("library"), @@ -118,6 +120,12 @@ all the results into a single target downstream.} \item{delimiter}{Character of length 1, string to insert between other strings when creating names of targets.} +\item{unlist}{Logical, whether to flatten the returned list of targets. +If \code{unlist = FALSE}, the list is nested and sub-lists +are named and grouped by the original input targets. +If \code{unlist = TRUE}, the return value is a flat list of targets +named by the new target names.} + \item{tidy_eval}{Whether to invoke tidy evaluation (e.g. the \verb{!!} operator from \code{rlang}) as soon as the target is defined (before \code{tar_make()}). Applies to the \code{command} argument.} @@ -151,7 +159,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -207,8 +215,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_quarto.Rd b/man/tar_quarto.Rd index 58297f8..05b5257 100644 --- a/man/tar_quarto.Rd +++ b/man/tar_quarto.Rd @@ -182,8 +182,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_quarto_rep.Rd b/man/tar_quarto_rep.Rd index 20e5ba6..287fac5 100644 --- a/man/tar_quarto_rep.Rd +++ b/man/tar_quarto_rep.Rd @@ -223,8 +223,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_render.Rd b/man/tar_render.Rd index d063a9a..671ddef 100644 --- a/man/tar_render.Rd +++ b/man/tar_render.Rd @@ -125,8 +125,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_render_rep.Rd b/man/tar_render_rep.Rd index 96412b2..1aa6463 100644 --- a/man/tar_render_rep.Rd +++ b/man/tar_render_rep.Rd @@ -168,8 +168,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_rep.Rd b/man/tar_rep.Rd index 5826e68..857151f 100644 --- a/man/tar_rep.Rd +++ b/man/tar_rep.Rd @@ -116,7 +116,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -192,8 +192,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_rep2.Rd b/man/tar_rep2.Rd index 5371c79..e589fca 100644 --- a/man/tar_rep2.Rd +++ b/man/tar_rep2.Rd @@ -122,7 +122,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -197,8 +197,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_rep_map.Rd b/man/tar_rep_map.Rd index 1d680a5..8c24d6e 100644 --- a/man/tar_rep_map.Rd +++ b/man/tar_rep_map.Rd @@ -95,7 +95,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -170,8 +170,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_rep_map_raw.Rd b/man/tar_rep_map_raw.Rd index d710526..48db58f 100644 --- a/man/tar_rep_map_raw.Rd +++ b/man/tar_rep_map_raw.Rd @@ -96,7 +96,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -171,8 +171,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process. diff --git a/man/tar_skip.Rd b/man/tar_skip.Rd index 60a5a9d..0d89dad 100644 --- a/man/tar_skip.Rd +++ b/man/tar_skip.Rd @@ -90,7 +90,7 @@ for details for instructions. See the cloud storage section of \url{https://books.ropensci.org/targets/data.html} for details for instructions. -\item A character string from \code{tar_repository_cas()} for content-addressable +\item A character string from \code{\link[targets:tar_repository_cas]{tar_repository_cas()}} for content-addressable storage. } @@ -165,8 +165,17 @@ and \code{"transient"} means it gets deleted as soon as possible. The former conserves bandwidth, and the latter conserves local storage.} -\item{garbage_collection}{Logical, whether to run \code{base::gc()} -just before the target runs.} +\item{garbage_collection}{Logical: \code{TRUE} to run \code{base::gc()} +just before the target runs, +\code{FALSE} to omit garbage collection. +In the case of high-performance computing, +\code{gc()} runs both locally and on the parallel worker. +All this garbage collection is skipped if the actual target +is skipped in the pipeline. +Non-logical values of \code{garbage_collection} are converted to \code{TRUE} or +\code{FALSE} using \code{isTRUE()}. In other words, non-logical values are +converted \code{FALSE}. For example, \code{garbage_collection = 2} +is equivalent to \code{garbage_collection = FALSE}.} \item{deployment}{Character of length 1. If \code{deployment} is \code{"main"}, then the target will run on the central controlling R process.