STAR: STAR Client

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

STAR Client

Description

Starts a query for STAR (mapping) using Toolchest.

Usage

STAR(
  tool_args = "",
  read_one,
  read_two = NULL,
  output_path = NULL,
  database_name = "GRCh38",
  database_version = "1",
  ...
)

Arguments

tool_args	(optional) Additional arguments to be passed to STAR.
read_one	Path of input file to be passed in as Read 1 (-1).
read_two	(optional) Path of input file to be passed in as Read 2 (-2).
output_path	(optional) Path to a directory where the output file(s) will be downloaded.
database_name	(optional) Name (string) of database to use for STAR mapping. Defaults to "GRCh38".
database_version	(optional) Version (string) of database to use for STAR mapping.
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.

Note

read_one is required. If paired-end reads are not used, the input file should be passed in as read_one.

database_name should be specified as well.

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