rapsearch2: RAPSearch2 Client

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

RAPSearch2 Client

Description

Runs Diamond in BLASTx mode via Toolchest.

Usage

rapsearch2(
  tool_args = "",
  inputs,
  output_path = NULL,
  output_primary_name = NULL,
  database_name = "rapsearch2_seqscreen",
  database_version = "1",
  ...
)

Arguments

tool_args	(optional) Additional arguments to be passed to RAPSearch2.
inputs	Path to a FASTA/FASTQ file that will be passed in as input.
output_path	(optional) Path (client-side) to a directory where the output files will be downloaded.
output_primary_name	(optional) Base name of output file(s). (Functions the same way as the "-o" tag for RAPSearch2, in combination with output_path.)
database_name	(optional) Name of database to use for RAPSearch2 alignment. Defaults to SeqScreen DB.
database_version	(optional) Version of database to use for RAPSearch2 alignment. Defaults to 1.
is_async	(optional) Whether to run a job asynchronously. Defaults to false.

Value

Reference to an object with output location data.

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