test: Test Pipeline Segment

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

Test Pipeline Segment

Description

Run a test pipeline segment via Toolchest. A plain text file containing 'success' is returned."

Usage

test(tool_args = "", inputs, output_path = NULL, ...)

Arguments

tool_args	Additional arguments, present to maintain a consistent interface. This is disregarded.
inputs	Path or list of paths (client-side) to be passed in as input.
output_path	(optional) Path to a directory where the output file(s) will be downloaded.
is_async	(optional) Whether to run a job asynchronously. Defaults to false.

Details

If output_path is left unspecified, downloading will be skipped.

Value

Reference to an object with output location data.

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