Skip to content

Commit

Permalink
Fix #1208
Browse files Browse the repository at this point in the history
  • Loading branch information
wlandau committed Jan 16, 2024
1 parent 9625907 commit 8ab4319
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 17 deletions.
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
11 changes: 7 additions & 4 deletions R/tar_target.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
#' <https://books.ropensci.org/targets/crew.html>.
#' @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
Expand Down
11 changes: 7 additions & 4 deletions man/tar_option_set.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 7 additions & 4 deletions man/tar_target.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 7 additions & 4 deletions man/tar_target_raw.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8ab4319

Please sign in to comment.