diff --git a/NEWS.md b/NEWS.md index e7563a8f..d32c0057 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,6 @@ # targets 1.4.1.9000 (development) - +* Update the documentation of the `deployment` argument of `tar_target()` to reflect the advent of `crew` (#1208, @psychelzh). # targets 1.4.1 diff --git a/R/tar_target.R b/R/tar_target.R index 87bea3ce..f8095e65 100644 --- a/R/tar_target.R +++ b/R/tar_target.R @@ -228,10 +228,13 @@ #' and the latter conserves local storage. #' @param garbage_collection Logical, whether to run `base::gc()` #' just before the target runs. -#' @param deployment Character of length 1, only relevant to -#' [tar_make_clustermq()] and [tar_make_future()]. If `"worker"`, -#' the target runs on a parallel worker. If `"main"`, -#' the target runs on the host machine / process managing the pipeline. +#' @param deployment Character of length 1. If `deployment` is +#' `"main"`, then the target will run on the central controlling R process. +#' Otherwise, if `deployment` is `"worker"` and you set up the pipeline +#' with distributed/parallel computing, then +#' the target runs on a parallel worker. For more on distributed/parallel +#' computing in `targets`, please visit +#' . #' @param priority Numeric of length 1 between 0 and 1. Controls which #' targets get deployed first when multiple competing targets are ready #' simultaneously. Targets with priorities closer to 1 get dispatched earlier diff --git a/man/tar_option_set.Rd b/man/tar_option_set.Rd index 78c04c75..96739638 100644 --- a/man/tar_option_set.Rd +++ b/man/tar_option_set.Rd @@ -196,10 +196,13 @@ and the latter conserves local storage.} \item{garbage_collection}{Logical, whether to run \code{base::gc()} just before the target runs.} -\item{deployment}{Character of length 1, only relevant to -\code{\link[=tar_make_clustermq]{tar_make_clustermq()}} and \code{\link[=tar_make_future]{tar_make_future()}}. If \code{"worker"}, -the target runs on a parallel worker. If \code{"main"}, -the target runs on the host machine / process managing the pipeline.} +\item{deployment}{Character of length 1. If \code{deployment} is +\code{"main"}, then the target will run on the central controlling R process. +Otherwise, if \code{deployment} is \code{"worker"} and you set up the pipeline +with distributed/parallel computing, then +the target runs on a parallel worker. For more on distributed/parallel +computing in \code{targets}, please visit +\url{https://books.ropensci.org/targets/crew.html}.} \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_target.Rd b/man/tar_target.Rd index 6132be84..9fcf0ce3 100644 --- a/man/tar_target.Rd +++ b/man/tar_target.Rd @@ -145,10 +145,13 @@ and the latter conserves local storage.} \item{garbage_collection}{Logical, whether to run \code{base::gc()} just before the target runs.} -\item{deployment}{Character of length 1, only relevant to -\code{\link[=tar_make_clustermq]{tar_make_clustermq()}} and \code{\link[=tar_make_future]{tar_make_future()}}. If \code{"worker"}, -the target runs on a parallel worker. If \code{"main"}, -the target runs on the host machine / process managing the pipeline.} +\item{deployment}{Character of length 1. If \code{deployment} is +\code{"main"}, then the target will run on the central controlling R process. +Otherwise, if \code{deployment} is \code{"worker"} and you set up the pipeline +with distributed/parallel computing, then +the target runs on a parallel worker. For more on distributed/parallel +computing in \code{targets}, please visit +\url{https://books.ropensci.org/targets/crew.html}.} \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_target_raw.Rd b/man/tar_target_raw.Rd index 7071bb6a..31859bdf 100644 --- a/man/tar_target_raw.Rd +++ b/man/tar_target_raw.Rd @@ -160,10 +160,13 @@ and the latter conserves local storage.} \item{garbage_collection}{Logical, whether to run \code{base::gc()} just before the target runs.} -\item{deployment}{Character of length 1, only relevant to -\code{\link[=tar_make_clustermq]{tar_make_clustermq()}} and \code{\link[=tar_make_future]{tar_make_future()}}. If \code{"worker"}, -the target runs on a parallel worker. If \code{"main"}, -the target runs on the host machine / process managing the pipeline.} +\item{deployment}{Character of length 1. If \code{deployment} is +\code{"main"}, then the target will run on the central controlling R process. +Otherwise, if \code{deployment} is \code{"worker"} and you set up the pipeline +with distributed/parallel computing, then +the target runs on a parallel worker. For more on distributed/parallel +computing in \code{targets}, please visit +\url{https://books.ropensci.org/targets/crew.html}.} \item{priority}{Numeric of length 1 between 0 and 1. Controls which targets get deployed first when multiple competing targets are ready