tar_resources_clustermq: Target resources: 'clustermq' high-performance computing

Description Usage Arguments Value Resources See Also Examples

View source: R/tar_resources_clustermq.R

Description

Create the clustermq argument of tar_resources() to specify optional high-performance computing settings for tar_make_clustermq(). For details, see the documentation of the clustermq R package and the corresponding argument names in this help file.

Usage

1

Arguments

template

Named list, template argument to clustermq::workers().

Value

Object of class "tar_resources_clustermq", to be supplied to the clustermq argument of tar_resources().

Resources

Functions tar_target() and tar_option_set() each takes an optional resources argument to supply non-default settings of various optional backends for data storage and high-performance computing. The tar_resources() function is a helper to supply those settings in the correct manner. Resources are all-or-nothing: if you specify any resources with tar_target(), all the resources from tar_option_get("resources") are dropped for that target. In other words, if you write tar_option_set(resources = resources_1) and then tar_target(x, my_command(), resources = resources_2), then everything in resources_1 is discarded for target x.

See Also

Other resources: tar_resources_aws(), tar_resources_feather(), tar_resources_fst(), tar_resources_future(), tar_resources_parquet(), tar_resources_qs(), tar_resources_url(), tar_resources()

Examples

1
2
3
4
5
6
7
8
# Somewhere in you target script file (usually _targets.R):
tar_target(
  name,
  command(),
  resources = tar_resources(
    clustermq = tar_resources_clustermq(template = list(n_cores = 2))
  )
)

targets documentation built on July 21, 2021, 5:07 p.m.