targets: tar_resources_aws – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

tar_resources_aws

Target resources: AWS storage formats

Description

Create the aws argument of tar_resources() to specify optional settings to AWS storage formats. See the format argument of tar_target() for details.

Usage

tar_resources_aws(
  bucket,
  prefix = targets::path_objects_dir_cloud(),
  region = NULL,
  part_size = 5 * (2^20)
)

Arguments

`bucket`	Character of length 1, name of an existing AWS S3 bucket to upload and download the return values of the affected targets during the pipeline.
`prefix`	Character of length 1, "directory path" in the S3 bucket where the target return values are stored.
`region`	Character of length 1, AWS region containing the S3 bucket. Set to `NULL` to use the default region.
`part_size`	Positive numeric of length 1, number of bytes for each part of a multipart upload. (Except the last part, which is the remainder.) In a multipart upload, each part must be at least 5 MB.

Value

Object of class "tar_resources_aws", to be supplied to the aws 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.

Examples

# Somewhere in you target script file (usually _targets.R):
tar_target(
  name,
  command(),
  format = "aws_qs",
  resources = tar_resources(
    aws = tar_resources_aws(bucket = "yourbucketname"),
    qs = tar_resources_qs(preset = "fast")
  )
)

targets

Dynamic Function-Oriented 'Make'-Like Declarative Workflows

v0.10.0

MIT + file LICENSE

Authors

William Michael Landau [aut, cre] (<https://orcid.org/0000-0003-1878-3253>), Matthew T. Warkentin [ctb], Samantha Oliver [rev] (<https://orcid.org/0000-0001-5668-1165>), Tristan Mahr [rev] (<https://orcid.org/0000-0002-8890-5116>), Eli Lilly and Company [cph]

Initial release