Main Content

getBowtie2Command

Translate object properties to Bowtie 2 options

Description

example

S = getBowtie2Command(object) returns a character vector S, representing the Bowtie 2 option syntax that corresponds to the modified object properties. By default, the function translates only the modified properties.

getBowtie2Command requires the Bioinformatics Toolbox™ Interface for Bowtie Aligner. If this support package is not installed, then the function provides a download link. For details, see Bioinformatics Toolbox Software Support Packages.

Note

getBowtie2Command is supported on Mac and UNIX® platforms only.

example

S = getBowtie2Command(object,'IncludeAll',TF) specifies whether to translate all the object properties (true) or only the modified properties (false).

Examples

collapse all

Create a Bowtie2AlignOptions object.

 alignOpt = Bowtie2AlignOptions;

Modify the object properties. For example, specify to trim four residues from the 3' and 5' ends before aligning.

 alignOpt.Trim3 = 4;
 alignOpt.Trim5 = 4;

Retrieve the equivalent Bowtie 2 option syntax for the modified properties.

 getbowtie2command(alignOpt)
ans =

    '-3 4 -5 4'

Input Arguments

collapse all

Bowtie 2 options object, specified as a Bowtie2AlignOptions, Bowtie2InspectOptions, or Bowtie2BuildOptions object.

Example: alignOpt

Flag to translate all object properties, specified as true or false. If true, the function translates all the object properties. If false, the function translates only the modified properties.

Example: true

Data Types: logical

Output Arguments

collapse all

Bowtie 2 option syntax [1], returned as a character vector. The syntax is prefixed by one or two dashes.

References

[1] Langmead, B., and S. Salzberg. "Fast gapped-read alignment with Bowtie 2." Nature Methods. 9, 2012, 357–359.

Introduced in R2018a