Test Runs

As seen in Running an Example Job, you can call the test function to mimic a Toolchest run.

test actually uploads your inputs to Toolchest's infrastructure. (Nothing is done to the files beyond the upload.)

Function Call

toolchest.test(
    inputs,
    output_path=None,
    tool_args="",
    is_async=False,
)
toolchest$kraken2(
    inputs,
    output_path = NULL,
    tool_args = "",
    is_async = FALSE
)

Function Arguments

Argument

Use in place of:

Description

inputs

input file location

Path or list of paths (client-side) to be passed in as input(s). This can be a local filepath or an AWS S3 URI.

output_path

output file location

(optional) Path to a directory where the output file will be downloaded.
If omitted, skips download. The output file can be downloaded manually.

tool_args

(optional) Note: This argument has no explicit function and will be completely ignored. Its purpose is to mimic the tool_args parameter, a catch-all parameter for all other arguments, for all other tools.

is_async

Whether to run a job asynchronously.

Output Files

test has one output file, test_output.txt, a text document that reads:

success

Notes

Amazon AWS S3 inputs

Publicly available files stored on AWS's S3 service can be passed in as inputs, using the file's S3 URI.

Async runs

Set the is_async parameter to true if you would like to run test asynchronously. See Asynchronous Runs for more information.


Did this page help you?