download: Download Functionality

In gotoolchest/toolchest-client-r: R Client for Toolchest

Download Functionality

Description

If output download is skipped or halted unexpectedly during any Toolchest job, the output file(s) can be downloaded manually via the following functions:

• toolchest::download(output_path, ...)As a base function

• output$download(output_path)From the output returned by any Toolchest job, invoking download as a function

Usage

download(
  output_path,
  s3_uri = NULL,
  run_id = NULL,
  pipeline_segment_instance_id = NULL,
  skip_decompression = FALSE
)

Arguments

output_path	Path to a local directory where the file(s) will be downloaded.
s3_uri	URI of file contained in S3. This can be passed from the parameter output$s3_uri from the output returned by a previous job.
run_id	Run ID of the job producing the output you would like to download.
pipeline_segment_instance_id	(DEPRECATED) Pipeline segment instance ID. Replace this argument with run_id instead.
skip_decompression	Whether to skip decompression of the downloaded file archive.

Details

If toolchest::download() is used, one of s3_uri or run_id must be provided. These can be found as variables of the output object returned from a previous Toolchest function call. Contact Toolchest for assistance if the output details cannot be recovered.

If output$download() is used from the output returned by any toolchest::tool() function call, then only output_path needs to be specified.

Value

Path(s) to downloaded and decompressed files. If skip_decompression is enabled, returns the path to the archive.

Examples

## Not run: 
output <- toolchest::test(...)
output$download(output_path = path)

output <- toolchest::test(...)
toolchest::download(output_path = path, s3_uri = output$s3_uri)

## End(Not run)

gotoolchest/toolchest-client-r documentation built on July 14, 2022, 7 a.m.