megahit: MEGAHIT Client

View source: R/tools.R

megahitR Documentation

MEGAHIT Client

Description

Starts a query for MEGAHIT using Toolchest.

Usage

megahit(
  tool_args = "",
  read_one = NULL,
  read_two = NULL,
  output_path = NULL,
  interleaved = NULL,
  ...
)

Arguments

tool_args

(optional) Additional arguments to be passed to MEGAHIT.

read_one

(optional) -1 inputs. Path (string) or list of paths for read 1 of paired-read input files.

read_two

(optional) -2 inputs. Path (string) or list of paths for read 2 of paired-read input files.

output_path

(optional) Path to a directory where the output file(s) will be downloaded.

interleaved

(optional) Path (string) or list of paths for interleaved paired-end files.

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.