Mercurial > repos > devteam > bowtie2
annotate bowtie2_wrapper.xml @ 4:1fc845afa3ac draft
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
| author | devteam |
|---|---|
| date | Tue, 21 Jul 2015 13:00:51 -0400 |
| parents | ceb6467e276c |
| children | 42bb952b4e3c |
| rev | line source |
|---|---|
|
4
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
1 <tool id="bowtie2" name="Bowtie2" version="0.5"> |
| 2 | 2 <!-- Wrapper compatible with Bowtie version 2.2.4 --> |
| 3 <description>- map reads against reference genome</description> | |
| 0 | 4 <version_command>bowtie2 --version</version_command> |
| 5 <requirements> | |
| 2 | 6 <requirement type="package" version="2.2.4">bowtie2</requirement> |
| 0 | 7 <requirement type="package" version="0.1.18">samtools</requirement> |
| 8 </requirements> | |
| 9 <command> | |
| 2 | 10 |
| 0 | 11 ## prepare bowtie2 index |
| 12 #set index_path = '' | |
| 13 #if str($reference_genome.source) == "history": | |
| 2 | 14 bowtie2-build "$reference_genome.own_file" genome && |
| 15 ln -s "$reference_genome.own_file" genome.fa && | |
| 0 | 16 #set index_path = 'genome' |
| 17 #else: | |
| 18 #set index_path = $reference_genome.index.fields.path | |
| 19 #end if | |
| 20 | |
| 21 ## execute bowtie2 | |
| 2 | 22 |
| 0 | 23 bowtie2 |
| 24 | |
| 25 ## number of threads | |
| 26 -p \${GALAXY_SLOTS:-4} | |
| 27 | |
| 28 ## index file path | |
| 29 -x $index_path | |
| 30 | |
| 31 | |
| 2 | 32 ## Fastq inputs |
| 33 #if str( $library.type ) == "single": | |
| 3 | 34 -U "${library.input_1}" |
| 2 | 35 #if str( $library.unaligned_file ) == "true": |
| 0 | 36 --un $output_unaligned_reads_l |
| 37 #end if | |
| 2 | 38 #elif str( $library.type ) == "paired": |
| 3 | 39 -1 "${library.input_1}" |
| 40 -2 "${library.input_2}" | |
| 2 | 41 #if str( $library.paired_options.paired_options_selector ) == "yes": |
| 42 -I "${library.paired_options.I}" | |
| 43 -X "${library.paired_options.X}" | |
| 44 ${library.paired_options.fr_rf_ff} | |
| 45 ${library.paired_options.no_mixed} | |
| 46 ${library.paired_options.no_discordant} | |
| 47 ${library.paired_options.dovetail} | |
| 48 ${library.paired_options.no_contain} | |
| 49 ${library.paired_options.no_overlap} | |
| 50 #end if | |
| 51 #if str( $library.unaligned_file ) == "true": | |
| 52 --un-conc $output_unaligned_reads_l | |
| 53 #end if | |
| 0 | 54 #else |
| 2 | 55 ## prepare collection |
| 56 -1 $library.input_1.forward | |
| 57 -2 $library.input_1.reverse | |
| 58 #if str( $library.paired_options.paired_options_selector ) == "yes": | |
| 59 -I "${library.paired_options.I}" | |
| 60 -X "${library.paired_options.X}" | |
| 61 ${library.paired_options.fr_rf_ff} | |
| 62 ${library.paired_options.no_mixed} | |
| 63 ${library.paired_options.no_discordant} | |
| 64 ${library.paired_options.dovetail} | |
| 65 ${library.paired_options.no_contain} | |
| 66 ${library.paired_options.no_overlap} | |
| 67 #end if | |
| 68 #if str( $library.unaligned_file ) == "true": | |
| 0 | 69 --un-conc $output_unaligned_reads_l |
| 70 #end if | |
| 71 #end if | |
| 72 | |
| 2 | 73 ## Readgroups |
| 74 #if str( $read_group.read_group_selector ) == "yes": | |
| 75 --rg-id "${read_group.rgid}" | |
| 76 --rg "SM:${read_group.rgsm}" | |
| 77 --rg "LB:${read_group.rglb}" | |
| 78 --rg "PL:${read_group.rgpl}" | |
| 79 #end if | |
| 0 | 80 |
| 2 | 81 ## Analysis type |
| 82 #if ( str( $analysis_type.analysis_type_selector ) == "simple" and str( $analysis_type.presets ) != "no_presets" ): | |
| 83 $analysis_type.presets | |
| 84 #elif str( $analysis_type.analysis_type_selector ) == "full": | |
| 85 #if str( $analysis_type.input_options.input_options_selector ) == "yes": | |
| 86 --skip "${analysis_type.input_options.skip}" | |
| 87 --qupto "${analysis_type.input_options.qupto}" | |
| 88 --trim5 "${analysis_type.input_options.trim5}" | |
| 89 --trim3 "${analysis_type.input_options.trim3}" | |
| 90 ${analysis_type.input_options.qv_encoding} | |
| 3 | 91 ${analysis_type.input_options.solexa_quals} |
| 92 ${analysis_type.input_options.int_quals} | |
| 0 | 93 #end if |
| 2 | 94 |
| 95 #if str( $analysis_type.alignment_options.alignment_options_selector ) == "yes": | |
| 3 | 96 -N "${analysis_type.alignment_options.N}" |
| 97 -L "${analysis_type.alignment_options.L}" | |
| 98 -i "${analysis_type.alignment_options.i}" | |
| 99 --n-ceil "${analysis_type.alignment_options.n_ceil}" | |
| 100 --dpad "${analysis_type.alignment_options.dpad}" | |
| 101 --gbar "${analysis_type.alignment_options.gbar}" | |
| 102 ${analysis_type.alignment_options.ignore_quals} | |
| 2 | 103 ${analysis_type.alignment_options.nofw} |
| 104 ${analysis_type.alignment_options.norc} | |
| 105 ${analysis_type.alignment_options.no_1mm_upfront} | |
| 106 #if str( $analysis_type.alignment_options.align_mode.align_mode_selector ) == "end-to-end": | |
| 107 --end-to-end | |
| 3 | 108 --score-min "${analysis_type.alignment_options.align_mode.score_min_ete}" |
| 2 | 109 #elif str( $analysis_type.alignment_options.align_mode.align_mode_selector ) == "local": |
| 110 --local | |
| 3 | 111 --score-min "${analysis_type.alignment_options.align_mode.score_min_loc}" |
| 2 | 112 #end if |
| 113 #end if | |
| 114 | |
| 115 #if str( $analysis_type.scoring_options.scoring_options_selector ) == "yes": | |
| 3 | 116 #if ( str( $analysis_type.alignment_options.alignment_options_selector ) == "yes" and str( $analysis_type.alignment_options.align_mode.align_mode_selector ) == "local" ): |
| 117 --ma "${analysis_type.scoring_options.ma}" | |
| 118 #end if | |
| 2 | 119 --mp "${analysis_type.scoring_options.mp}" |
| 120 --np "${analysis_type.scoring_options.np}" | |
| 121 --rdg "${analysis_type.scoring_options.rdg_read_open},${analysis_type.scoring_options.rdg_read_extend}" | |
| 122 --rfg "${analysis_type.scoring_options.rfg_ref_open},${analysis_type.scoring_options.rfg_ref_extend}" | |
| 123 #end if | |
| 124 | |
| 125 #if str( $analysis_type.reporting_options.reporting_options_selector ) == "k": | |
| 126 -k "${analysis_type.reporting_options.k}" | |
| 127 #elif str( $analysis_type.reporting_options.reporting_options_selector ) == "a": | |
| 128 -a | |
| 129 #end if | |
| 130 | |
| 131 #if str( $analysis_type.effort_options.effort_options_selector ) == "yes": | |
| 132 -D "${analysis_type.effort_options.D}" | |
| 133 -R "${analysis_type.effort_options.R}" | |
| 134 #end if | |
| 135 | |
| 136 #if str( $analysis_type.sam_options.sam_options_selector ) == "yes": | |
| 3 | 137 ${analysis_type.sam_options.no_unal} |
| 138 ${analysis_type.sam_options.omit_sec_seq} | |
| 2 | 139 #end if |
| 140 | |
| 141 #if str( $analysis_type.other_options.other_options_selector ) == "yes": | |
| 3 | 142 ${analysis_type.other_options.non_deterministic} |
| 2 | 143 --seed "${analysis_type.other_options.seed}" |
| 0 | 144 #end if |
| 145 | |
| 2 | 146 #elif str( $analysis_type.analysis_type_selector ) == "cline": |
| 147 ${analysis_type.cline} | |
|
4
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
148 #end if |
| 0 | 149 |
|
4
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
150 -S "galaxy_bowtie_2_output.sam" && |
|
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
151 |
| 2 | 152 ## view/sort and output BAM file |
|
4
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
153 ( samtools view -Su "galaxy_bowtie_2_output.sam" | samtools sort -o - - > $output ) |
| 3 | 154 |
| 0 | 155 ## rename unaligned sequence files |
| 156 #if $library.type == "paired" and $output_unaligned_reads_l and $output_unaligned_reads_r: | |
|
4
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
157 #from os.path import splitext |
|
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
158 #set _unaligned_root, _unaligned_ext = splitext( str( $output_unaligned_reads_l ) ) |
|
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
159 && mv "${ _unaligned_root }.1${_unaligned_ext}" "${ output_unaligned_reads_l }" |
|
1fc845afa3ac
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/bowtie2 commit 32fe80982b5c59687eece667f0372002588566f8-dirty
devteam
parents:
3
diff
changeset
|
160 && mv "${ _unaligned_root }.2${_unaligned_ext}" "${ output_unaligned_reads_r }" |
| 0 | 161 #end if |
| 2 | 162 |
| 0 | 163 </command> |
| 164 | |
| 165 <!-- basic error handling --> | |
| 166 <stdio> | |
| 167 <exit_code range="1:" level="fatal" description="Tool exception" /> | |
| 168 </stdio> | |
| 169 | |
| 170 <inputs> | |
| 171 <!-- single/paired --> | |
| 172 <conditional name="library"> | |
| 2 | 173 <param name="type" type="select" label="Is this single or paired library"> |
| 0 | 174 <option value="single">Single-end</option> |
| 175 <option value="paired">Paired-end</option> | |
| 2 | 176 <option value="paired_collection">Paired-end Dataset Collection</option> |
| 0 | 177 </param> |
| 2 | 178 |
| 0 | 179 <when value="single"> |
| 180 <param name="input_1" format="fastqsanger" type="data" label="FASTQ file" help="Nucleotide-space: Must have Sanger-scaled quality values with ASCII offset 33"/> | |
| 2 | 181 <param name="unaligned_file" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Write unaligned reads (in fastq format) to separate file(s)" help="--un/--un-conc; This triggers --un parameter for single reads and --un-conc for paired reads" /> |
| 0 | 182 </when> |
| 183 <when value="paired"> | |
| 184 <param name="input_1" format="fastqsanger" type="data" label="FASTQ file" help="Nucleotide-space: Must have Sanger-scaled quality values with ASCII offset 33" /> | |
| 185 <param name="input_2" format="fastqsanger" type="data" label="FASTQ file" help="Nucleotide-space: Must have Sanger-scaled quality values with ASCII offset 33" /> | |
| 2 | 186 <param name="unaligned_file" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Write unaligned reads (in fastq format) to separate file(s)" help="--un/--un-conc; This triggers --un parameter for single reads and --un-conc for paired reads" /> |
| 187 <conditional name="paired_options"> | |
| 188 <param name="paired_options_selector" type="select" label="Do you want to set paired-end options?" help="See "Alignment Options" section of Help below for information"> | |
| 189 <option value="no" selected="True">No</option> | |
| 190 <option value="yes">Yes</option> | |
| 191 </param> | |
| 192 <when value="yes"> | |
| 193 <param name="I" type="integer" value="0" min="0" label="Set the minimum fragment length for valid paired-end alignments" help="-I/--minins; E.g. if `-I 60` is specified and a paired-end alignment consists of two 20-bp alignments in the appropriate orientation with a 20-bp gap between them, that alignment is considered valid (as long as `-X` is also satisfied). A 19-bp gap would not be valid in that case. If trimming options `-3` or `-5` are also used, the `-I` constraint is applied with respect to the untrimmed mates. The larger the difference between `-I` and `-X`, the slower Bowtie 2 will run. This is because larger differences bewteen `-I` and `-X` require that Bowtie 2 scan a larger window to determine if a concordant alignment exists. For typical fragment length ranges (200 to 400 nucleotides), Bowtie 2 is very efficient. Default=0"/> | |
| 3 | 194 <param name="X" type="integer" value="500" min="0" label="Set the maximum fragment length for valid paired-end alignments" help="-X/--maxins; E.g. if `-X 100` is specified and a paired-end alignment consists of two 20-bp alignments in the proper orientation with a 60-bp gap between them, that alignment is considered valid (as long as `-I` is also satisfied). A 61-bp gap would not be valid in that case. If trimming options `-3` or `-5` are also used, the `-X` constraint is applied with respect to the untrimmed mates, not the trimmed mates; Default=500"/> |
| 195 <param name="fr_rf_ff" type="select" display="radio" label="Select the upstream/downstream mate orientations for a valid paired-end alignment against the forward reference strand" help="--fr, --rf, or --ff; E.g., if `--fr` is specified and there is a candidate paired-end alignment where mate 1 appears upstream of the reverse complement of mate 2 and the fragment length constraints (`-I` and `-X`) are met, that alignment is valid. Also, if mate 2 appears upstream of the reverse complement of mate 1 and all other constraints are met, that too is valid. `--rf` likewise requires that an upstream mate1 be reverse-complemented and a downstream mate2 be forward-oriented. `--ff` requires both an upstream mate 1 and a downstream mate 2 to be forward-oriented; Default=--fr (appropriate for Illumina's Paired-end Sequencing Assay)"> | |
| 2 | 196 <option value="--fr" selected="True">--fr</option> |
| 3 | 197 <option value="--rf">--rf</option> |
| 2 | 198 <option value="--ff">--ff</option> |
| 199 </param> | |
| 200 <param name="no_mixed" type="boolean" truevalue="--no-mixed" falsevalue="" checked="False" label="Disable no-mixed behavior" help="--no-mixed; By default, when `bowtie2` cannot find a concordant or discordant alignment for a pair, it then tries to find alignments for the individual mates; default=False"/> | |
| 201 <param name="no_discordant" type="boolean" truevalue="--no-discordant" falsevalue="" checked="False" label="Disable no-discordant behavior" help="--no-discordant; By default, `bowtie2` looks for discordant alignments if it cannot find any concordant alignments. A discordant alignment is an alignment where both mates align uniquely, but that does not satisfy the paired-end constraints (`--fr`/`--rf`/`--ff`, `-I`, `-X`); default=False"/> | |
| 3 | 202 <param name="dovetail" type="boolean" truevalue="--dovetail" falsevalue="" checked="False" label="Allow mate dovetailing" help="--dovetail; If the mates `dovetail`, that is if one mate alignment extends past the beginning of the other such that the wrong mate begins upstream, consider that to be concordant. Default=False"/> |
| 203 <param name="no_contain" type="boolean" truevalue="--no-contain" falsevalue="" checked="False" label="Allow one mate alignment to contain another" help="--no-contain; If one mate alignment contains the other, consider that to be non-concordant. Default=False"/> | |
| 204 <param name="no_overlap" type="boolean" truevalue="--no-overlap" falsevalue="" checked="False" label="Allow mate alignments to overlap" help="--no-overlap; If one mate alignment overlaps the other at all, consider that to be non-concordant. Default=False"/> | |
| 2 | 205 </when> |
| 206 <when value="no"> | |
| 207 <!-- do nothing --> | |
| 208 </when> | |
| 209 </conditional> | |
| 210 </when> | |
| 211 <when value="paired_collection"> | |
| 212 <param name="input_1" format="fastqsanger" type="data_collection" collection_type="paired" label="FASTQ Paired Dataset" help="Nucleotide-space: Must have Sanger-scaled quality values with ASCII offset 33" /> | |
| 213 <param name="unaligned_file" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Write unaligned reads (in fastq format) to separate file(s)" help="--un/--un-conc; This triggers --un parameter for single reads and --un-conc for paired reads" /> | |
| 214 <conditional name="paired_options"> | |
| 215 <param name="paired_options_selector" type="select" label="Do you want to set paired-end options?" help="See "Alignment Options" section of Help below for information"> | |
| 216 <option value="no" selected="True">No</option> | |
| 217 <option value="yes">Yes</option> | |
| 218 </param> | |
| 219 <when value="yes"> | |
| 220 <param name="I" type="integer" value="0" min="0" label="Set the minimum fragment length for valid paired-end alignments" help="-I/--minins; E.g. if `-I 60` is specified and a paired-end alignment consists of two 20-bp alignments in the appropriate orientation with a 20-bp gap between them, that alignment is considered valid (as long as `-X` is also satisfied). A 19-bp gap would not be valid in that case. If trimming options `-3` or `-5` are also used, the `-I` constraint is applied with respect to the untrimmed mates. The larger the difference between `-I` and `-X`, the slower Bowtie 2 will run. This is because larger differences bewteen `-I` and `-X` require that Bowtie 2 scan a larger window to determine if a concordant alignment exists. For typical fragment length ranges (200 to 400 nucleotides), Bowtie 2 is very efficient. Default=0"/> | |
| 3 | 221 <param name="X" type="integer" value="500" min="0" label="Set the maximum fragment length for valid paired-end alignments" help="-X/--maxins; E.g. if `-X 100` is specified and a paired-end alignment consists of two 20-bp alignments in the proper orientation with a 60-bp gap between them, that alignment is considered valid (as long as `-I` is also satisfied). A 61-bp gap would not be valid in that case. If trimming options `-3` or `-5` are also used, the `-X` constraint is applied with respect to the untrimmed mates, not the trimmed mates; Default=500"/> |
| 222 <param name="fr_rf_ff" type="select" display="radio" label="Select the upstream/downstream mate orientations for a valid paired-end alignment against the forward reference strand" help="--fr, --rf, or --ff; E.g., if `--fr` is specified and there is a candidate paired-end alignment where mate 1 appears upstream of the reverse complement of mate 2 and the fragment length constraints (`-I` and `-X`) are met, that alignment is valid. Also, if mate 2 appears upstream of the reverse complement of mate 1 and all other constraints are met, that too is valid. `--rf` likewise requires that an upstream mate1 be reverse-complemented and a downstream mate2 be forward-oriented. `--ff` requires both an upstream mate 1 and a downstream mate 2 to be forward-oriented; Default=--fr (appropriate for Illumina's Paired-end Sequencing Assay)"> | |
| 2 | 223 <option value="--fr" selected="True">--fr</option> |
| 3 | 224 <option value="--rf">--rf</option> |
| 2 | 225 <option value="--ff">--ff</option> |
| 226 </param> | |
| 227 <param name="no_mixed" type="boolean" truevalue="--no-mixed" falsevalue="" checked="False" label="Disable no-mixed behavior" help="--no-mixed; By default, when `bowtie2` cannot find a concordant or discordant alignment for a pair, it then tries to find alignments for the individual mates; default=False"/> | |
| 228 <param name="no_discordant" type="boolean" truevalue="--no-discordant" falsevalue="" checked="False" label="Disable no-discordant behavior" help="--no-discordant; By default, `bowtie2` looks for discordant alignments if it cannot find any concordant alignments. A discordant alignment is an alignment where both mates align uniquely, but that does not satisfy the paired-end constraints (`--fr`/`--rf`/`--ff`, `-I`, `-X`); default=False"/> | |
| 3 | 229 <param name="dovetail" type="boolean" truevalue="--dovetail" falsevalue="" checked="False" label="Allow mate dovetailing" help="--dovetail; If the mates `dovetail`, that is if one mate alignment extends past the beginning of the other such that the wrong mate begins upstream, consider that to be concordant. Default=False"/> |
| 230 <param name="no_contain" type="boolean" truevalue="--no-contain" falsevalue="" checked="False" label="Allow one mate alignment to contain another" help="--no-contain; If one mate alignment contains the other, consider that to be non-concordant. Default=False"/> | |
| 231 <param name="no_overlap" type="boolean" truevalue="--no-overlap" falsevalue="" checked="False" label="Allow mate alignments to overlap" help="--no-overlap; If one mate alignment overlaps the other at all, consider that to be non-concordant. Default=False"/> | |
| 2 | 232 </when> |
| 233 <when value="no"> | |
| 234 <!-- do nothing --> | |
| 235 </when> | |
| 236 </conditional> | |
| 0 | 237 </when> |
| 238 </conditional> | |
| 2 | 239 |
| 0 | 240 <!-- reference genome --> |
| 241 <conditional name="reference_genome"> | |
| 2 | 242 <param name="source" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="Built-ins were indexed using default options. See `Indexes` section of help below"> |
| 243 <option value="indexed">Use a built-in genome index</option> | |
| 244 <option value="history">Use a genome from the history and build index</option> | |
| 0 | 245 </param> |
| 246 <when value="indexed"> | |
| 2 | 247 <param name="index" type="select" label="Select reference genome" help="If your genome of interest is not listed, contact the Galaxy team"> |
| 0 | 248 <options from_data_table="bowtie2_indexes"> |
| 249 <filter type="sort_by" column="2"/> | |
| 250 <validator type="no_options" message="No indexes are available for the selected input dataset"/> | |
| 251 </options> | |
| 252 </param> | |
| 253 </when> | |
| 254 <when value="history"> | |
| 2 | 255 <param name="own_file" type="data" format="fasta" metadata_name="dbkey" label="Select reference genome" /> |
| 0 | 256 </when> |
| 257 </conditional> | |
| 258 | |
| 2 | 259 <!-- read group settings --> |
| 0 | 260 <conditional name="read_group"> |
| 2 | 261 <param name="read_group_selector" type="select" label="Specify the read group for this file?" help="Specifying readgroup information can greatly simplify your downstream analyses by allowing combining multiple datasets. See help below for more details"> |
| 0 | 262 <option value="yes">Yes</option> |
| 263 <option value="no" selected="True">No</option> | |
| 264 </param> | |
| 265 <when value="yes"> | |
| 2 | 266 <param name="rgid" type="text" size="25" label="Read group identifier (ID). Each @RG line must have a unique ID. The value of ID is used in the RG tags of alignment records. Must be unique among all read groups in header section." help="--rg-id; Required if RG specified. Read group IDs may be modified when merging SAM files in order to handle collisions." /> |
| 267 <param name="rglb" type="text" size="25" label="Library name (LB)" help="--rg; Required if RG specified" /> | |
| 268 <param name="rgpl" type="text" size="25" label="Platform/technology used to produce the reads (PL)" help="--rg; Required if RG specified. Valid values : CAPILLARY, LS454, ILLUMINA, SOLID, HELICOS, IONTORRENT and PACBIO" /> | |
| 269 <param name="rgsm" type="text" size="25" label="Sample (SM)" help="--rg; Required if RG specified. Use pool name where a pool is being sequenced" /> | |
| 0 | 270 </when> |
| 271 <when value="no" /> | |
| 272 </conditional> | |
| 273 | |
| 2 | 274 <conditional name="analysis_type"> |
| 275 <param name="analysis_type_selector" type="select" label="Select analysis mode"> | |
| 276 <option value="simple">1: Default setting only</option> | |
| 277 <option value="full">2: Full parameter list</option> | |
| 0 | 278 </param> |
| 2 | 279 <when value="simple"> |
| 280 <param name="presets" type="select" display="radio" label="Do you want to use presets?" help="Allow selecting among several preset parameter settings. Choosing between these will result in dramatic changes in runtime. See help below to understand effects of these presets."> | |
| 281 <option value="no_presets" selected="True">No, just use defaults</option> | |
| 282 <option value="--very-fast">Very fast end-to-end (--very-fast)</option> | |
| 283 <option value="--fast">Fast end-to-end (--fast)</option> | |
| 284 <option value="--sensitive">Sensitive end-to-end (--sensitive)</option> | |
| 285 <option value="--very-sensitive">Very sensitive end-to-end (--very-sensitive)</option> | |
| 286 <option value="--very-fast-local">Very fast local (--very-fast-local)</option> | |
| 287 <option value="--fast-local">Fast local (--fast-local)</option> | |
| 288 <option value="--sensitive-local">Sensitive local (--sensitive-local)</option> | |
| 289 <option value="--very-sensitive-local">Very sensitive local (--very-sensitive-local)</option> | |
| 0 | 290 </param> |
| 2 | 291 </when> |
| 292 <when value="full"> | |
| 293 <conditional name="input_options"> | |
| 294 <param name="input_options_selector" type="select" label="Do you want to tweak input options?" help="See "Input Options" section of Help below for information"> | |
| 295 <option value="yes">Yes</option> | |
| 296 <option value="no" selected="true">No</option> | |
| 297 </param> | |
| 298 <when value="yes"> | |
| 3 | 299 <param name="skip" type="integer" min="0" value="0" label="Skip (i.e. do not align) the first that many reads or pairs in the input" help="-s/--skip; default=0"/> |
| 300 <param name="qupto" type="integer" min="1" value="100000000" label="Align the first that many reads or read pairs from the input (after the -s/--skip reads or pairs have been skipped), then stop" help="-u/--qupto; for default behavior (no limit) leave this value very large"/> | |
| 2 | 301 <param name="trim5" type="integer" min="0" value="0" label="Trim that many bases from 5' (left) end of each read before alignment" help="-5/--trim5; default=0"/> |
| 302 <param name="trim3" type="integer" min="0" value="0" label="Trim that many bases from 3' (right) end of each read before alignment" help="-3/--trim3; default=0"/> | |
| 303 <param name="qv_encoding" type="select" display="radio" label="Select quality score encoding" help="See help below for more details"> | |
| 3 | 304 <option value="--phred33" selected="True">Input qualities are ASCII chars equal to the Phred quality plus 33. This is also called the "Phred+33" encoding, which is used by the very latest Illumina pipelines (--phred33)</option> |
| 305 <option value="--phred64">Input qualities are ASCII chars equal to the Phred quality plus 64. This is also called the "Phred+64" encoding (--phred64)</option> | |
| 2 | 306 </param> |
| 3 | 307 <param name="solexa_quals" type="boolean" truevalue="--solexa-quals" falsevalue="" checked="False" label="Convert input qualities from Solexa (which can be negative) to Phred (which can't). This scheme was used in older Illumina GA Pipeline versions (prior to 1.3)" help="--solexa-quals; default=False"/> |
| 308 <param name="int_quals" type="boolean" truevalue="--int-quals" falsevalue="" checked="False" label="Quality values are represented in the read input file as space-separated ASCII integers, e.g., 40 40 30 40..., rather than ASCII characters, e.g., II?I.... Integers are treated as being on the Phred quality scale unless --solexa-quals is also specified" help="--int-quals; default=False"/> | |
| 2 | 309 </when> |
| 310 <when value="no"> | |
| 311 <!-- do nothing --> | |
| 312 </when> | |
| 313 </conditional> | |
| 314 <conditional name="alignment_options"> | |
| 315 <param name="alignment_options_selector" type="select" label="Do you want to tweak alignment options?" help="See "Alignment Options" section of Help below for information"> | |
| 316 <option value="yes">Yes</option> | |
| 317 <option value="no" selected="true">No</option> | |
| 318 </param> | |
| 319 <when value="yes"> | |
| 320 <param name="N" type="integer" min="0" max="1" value="0" label="Set the number of mismatches to be allowed in a seed alignment during multiseed alignment (see `Multiseed alignment` section of help below)" help="-N; Can be set to 0 or 1. Setting this higher makes alignment slower (often much slower) but increases sensitivity; default=0"/> | |
| 3 | 321 <param name="L" type="integer" min="0" max="32" value="22" label="Sets the length of the seed substrings to align during multiseed alignment (see `Multiseed alignment` section of help below)" help="-L; Smaller values make alignment slower but more sensitive. Default=22"/> |
| 322 <param name="i" type="text" value="S,1,1.15" size="10" label="Set a function governing the interval between seed substrings to use during multiseed alignment (see `Multiseed alignment` section of help below). Also see description of this option below in the help section" help="-i; Since it's best to use longer intervals for longer reads, this parameter sets the interval as a function of the read length, rather than a single one-size-fits-all number. For instance, specifying `-i S,1,2.5` sets the interval function `f` to `f(x) = 1 + 2.5 * sqrt(x)`, where x is the read length. If the function returns a result less than 1, it is rounded up to 1. Default=`S,1,1.15`"/> | |
| 323 <param name="n_ceil" type="text" value="L,0,0.15" label="Set a function governing the maximum number of ambiguous characters (usually `N`s and/or `.`s) allowed in a read as a function of read length" help="--n-ceil; For instance, specifying `L,0,0.15` sets the N-ceiling function `f` to `f(x) = 0 + 0.15 * x`, where x is the read length. Reads exceeding this ceiling are filtered out. Default=`L,0,0.15`"/> | |
| 324 <param name="dpad" type="integer" min="0" value="15" label="Pad dynamic programming problems by that many columns on either side to allow gaps" help="--dpad; default=15"/> | |
| 2 | 325 <param name="gbar" type="integer" min="0" value="4" label="Disallow gaps within that many positions of the beginning or end of the read" help="--gbar; default=4"/> |
| 3 | 326 <param name="ignore_quals" type="boolean" truevalue="--ignore-quals" falsevalue="" selected="False" label="When calculating a mismatch penalty, always consider the quality value at the mismatched position to be the highest possible, regardless of the actual value" help="--ignore-quals; input is treated as though all quality values are high; default=False"/> |
| 2 | 327 <param name="nofw" type="boolean" truevalue="--nofw" falsevalue="" selected="False" label="Do not attempt to align unpaired reads to the forward (Watson) reference strand" help="In paired-end mode, `--nofw` and `--norc` pertain to the fragments; i.e. specifying `--nofw` causes `bowtie2` to explore only those paired-end configurations corresponding to fragments from the reverse-complement (Crick) strand. Default=False"/> |
| 328 <param name="norc" type="boolean" truevalue="--norc" falsevalue="" selected="False" label="Do not attempt to align unpaired reads to the reverse (Crick) reference strand" help="In paired-end mode, `--nofw` and `--norc` pertain to the fragments; i.e. specifying `--nofw` causes `bowtie2` to explore only those paired-end configurations corresponding to fragments from the reverse-complement (Crick) strand. Default=False"/> | |
| 3 | 329 <param name="no_1mm_upfront" type="boolean" truevalue="--no-1mm-upfront" falsevalue="" selected="False" label="Prevent searching for 1-mismatch end-to-end alignments before using the multiseed heuristic (see `Multiseed alignment` section of help below)" help="--no-1mm-upfront; By default, Bowtie 2 will attempt to find either an exact or a 1-mismatch end-to-end alignment for the read *before* trying the multiseed heuristic. Such alignments can be found very quickly, and many short read alignments have exact or near-exact end-to-end alignments. However, this can lead to unexpected alignments when the user also sets options governing the multiseed heuristic, like `-L` and `-N`. For instance, if the user specifies `-N 0` and `-L` equal to the length of the read, the user will be surprised to find 1-mismatch alignments reported. This option prevents Bowtie 2 from searching for 1-mismatch end-to-end alignments before using the multiseed heuristic, which leads to the expected behavior when combined with options such as `-L` and `-N`. This comes at the expense of speed; Default=False"/> |
| 2 | 330 <conditional name="align_mode"> |
| 331 <param name="align_mode_selector" type="select" display="radio" label="Select between `--local` and `--end-to-end` alignment modes" help="--local and --end-to-end; see help below for detailed explanation; default=--end-to-end"> | |
| 332 <option value="end-to-end" selected="True">End to End (--end-to-end)</option> | |
| 333 <option value="local">Local (--local)</option> | |
| 334 </param> | |
| 335 <when value="end-to-end"> | |
| 3 | 336 <param name="score_min_ete" type="text" value="L,-0.6,-0.6" label="Set a function governing the minimum alignment score needed for an alignment to be considered `valid` (i.e. good enough to report)" help="--score-min; This is a function of read length. For instance, specifying `L,0,-0.6` sets the minimum-score function `f` to `f(x) = 0 + -0.6 * x`, where `x` is the read length. The default in `--end-to-end` mode is `L,-0.6,-0.6` and the default in `--local` mode is `G,20,8`"/> |
| 2 | 337 </when> |
| 338 <when value="local"> | |
| 3 | 339 <param name="score_min_loc" type="text" value="G,20,8" label="Set a function governing the minimum alignment score needed for an alignment to be considered `valid` (i.e. good enough to report)" help="--score-min; This is a function of read length. For instance, specifying `L,0,-0.6` sets the minimum-score function `f` to `f(x) = 0 + -0.6 * x`, where `x` is the read length. The default in `--end-to-end` mode is `L,-0.6,-0.6` and the default in `--local` mode is `G,20,8`"/> |
| 2 | 340 </when> |
| 341 </conditional> | |
| 342 </when> | |
| 343 <when value="no"> | |
| 344 <!-- do nothing --> | |
| 345 </when> | |
| 346 </conditional> | |
| 347 <conditional name="scoring_options"> | |
| 348 <param name="scoring_options_selector" type="select" label="Do you want to tweak scoring options?" help="See "Scoring Options" section of Help below for information"> | |
| 349 <option value="yes">Yes</option> | |
| 350 <option value="no" selected="true">No</option> | |
| 351 </param> | |
| 352 <when value="yes"> | |
| 353 <param name="ma" type="integer" value="2" label="Set the match bonus" help="--ma; In `--local` mode match bonus is added to the alignment score for each position where a read character aligns to a reference character and the characters match. Not used in `--end-to-end` mode; Default=2"/> | |
| 354 <param name="mp" type="text" size="10" value="6,2" label="Set the maximum (`MX`) and minimum (`MN`) mismatch penalties, both integers" help="--mp; A number less than or equal to `MX` and greater than or equal to `MN` is subtracted from the alignment score for each position where a read character aligns to a reference character, the characters do not match, and neither is an `N`. If `--ignore-quals` is specified, the number subtracted quals `MX`. Otherwise, the number subtracted is `MN + floor( (MX-MN)(MIN(Q, 40.0)/40.0) )` where Q is the Phred quality value; Default=6,2"/> | |
| 355 <param name="np" type="integer" value="1" label="Sets penalty for positions where the read, reference, or both, contain an ambiguous character such as `N`" help="--np; Default=1"/> | |
| 356 <param name="rdg_read_open" type="integer" value="5" label="Set the read gap opening penalty" help="--rdg; this is the first component of --rdg flag - opening penalty; Default=5"/> | |
| 357 <param name="rdg_read_extend" type="integer" value="3" label="Set the read gap extension penalty" help="--rdg; this is the second component of --rdg flag - extension penalty; Default=3"/> | |
| 358 <param name="rfg_ref_open" type="integer" value="5" label="Set the reference gap opening penalty" help="--rfg; this is the first component of --rfg flag - opening penalty; Default=5"/> | |
| 359 <param name="rfg_ref_extend" type="integer" value="3" label="Set the reference gap extension penalty" help="--rfg; this is the second component of --rfg flag - extension penalty; Default=3"/> | |
| 360 </when> | |
| 361 <when value="no"> | |
| 362 <!-- do nothing --> | |
| 363 </when> | |
| 364 </conditional> | |
| 365 <conditional name="reporting_options"> | |
| 366 <param name="reporting_options_selector" type="select" label="Do you want to use -a or -k options" help="Make sure you understand implications of setting -k and -a. See "Reporting Options" section of Help below for information on -k and -a options"> | |
| 367 <option value="no" selected="true">No, do not set</option> | |
| 368 <option value="k">Set -k option and enter -k value</option> | |
| 369 <option value="a">Set -a option</option> | |
| 370 </param> | |
| 371 <when value="no"> | |
| 372 <!-- do nothing --> | |
| 373 </when> | |
| 3 | 374 <when value="k"> |
| 375 <param name="k" type="integer" min="1" value="1" label="Searches for at most that many distinct, valid alignments for each read" help="-k; see detailed description of this option in the help section below. Note: Bowtie 2 is not designed with large values for `-k` in mind, and when aligning reads to long, repetitive genomes large `-k` can be very, very slow"/> | |
| 2 | 376 </when> |
| 3 | 377 <when value="a"> |
| 2 | 378 <!-- do nothing here; set -a flag on the command line--> |
| 379 </when> | |
| 380 </conditional> | |
| 381 <conditional name="effort_options"> | |
| 382 <param name="effort_options_selector" type="select" label="Do you want to tweak effort options?" help="See "Effort Options" section of Help below for information"> | |
| 383 <option value="yes">Yes</option> | |
| 384 <option value="no" selected="true">No</option> | |
| 385 </param> | |
| 386 <when value="yes"> | |
| 3 | 387 <param name="D" type="integer" value="15" min="0" label="Attempt that many consecutive seed extension attempts to `fail` before Bowtie 2 moves on, using the alignments found so far" help="-D; A seed extension `fails` if it does not yield a new best or a new second-best alignment. This limit is automatically adjusted up when -k or -a are specified. Default=15"/> |
| 2 | 388 <param name="R" type="integer" value="2" min="0" label="Set the maximum number of times Bowtie 2 will `re-seed` reads with repetitive seeds" help="When `re-seeding`, Bowtie 2 simply chooses a new set of reads (same length, same number of mismatches allowed) at different offsets and searches for more alignments. A read is considered to have repetitive seeds if the total number of seed hits divided by the number of seeds that aligned at least once is greater than 300. Default=2"/> |
| 389 </when> | |
| 390 <when value="no"> | |
| 391 <!-- do nothing --> | |
| 392 </when> | |
| 393 </conditional> | |
| 0 | 394 |
| 2 | 395 <conditional name="sam_options"> |
| 396 <param name="sam_options_selector" type="select" label="Do you want to tweak SAM/BAM Options?" help="See "Output Options" section of Help below for information"> | |
| 397 <option value="yes">Yes</option> | |
| 398 <option value="no" selected="true">No</option> | |
| 399 </param> | |
| 400 <when value="yes"> | |
| 3 | 401 <param name="no_unal" type="boolean" truevalue="--no-unal" falsevalue="" label="Suppress SAM records for reads that failed to align" help="--no-unal; Default=False"/> |
| 402 <param name="omit_sec_seq" type="boolean" truevalue="--omit-sec-seq" falsevalue="" label="Suppress SEQ and QUAL strings for secondary alignments" help="--omit-sec-seq; Default=False"/> | |
| 2 | 403 </when> |
| 404 <when value="no"> | |
| 405 <!-- do nothing --> | |
| 406 </when> | |
| 407 </conditional> | |
| 408 <conditional name="other_options"> | |
| 409 <param name="other_options_selector" type="select" label="Do you want to tweak Other Options?" help="See "Other Options" section of Help below for information"> | |
| 410 <option value="yes">Yes</option> | |
| 411 <option value="no" selected="true">No</option> | |
| 412 </param> | |
| 413 <when value="yes"> | |
| 414 <param name="seed" type="integer" value="0" min="0" label="Use this number as the seed for pseudo-random number generator" help="--seed; Default=0"/> | |
| 3 | 415 <param name="non_deterministic" type="boolean" truevalue="--non-deterministic" falsevalue="" label="Re-initialize the pseudo-random generator for each read using the current time" help="--non-deterministic; see Help below for explanation of this option; default=False"/> |
| 2 | 416 </when> |
| 417 <when value="no"> | |
| 418 <!-- do nothing --> | |
| 419 </when> | |
| 420 </conditional> | |
| 0 | 421 </when> |
| 422 </conditional> | |
| 423 </inputs> | |
| 424 | |
| 425 <!-- define outputs --> | |
| 2 | 426 |
| 0 | 427 <outputs> |
| 2 | 428 |
| 0 | 429 <data format="fastqsanger" name="output_unaligned_reads_l" label="${tool.name} on ${on_string}: unaligned reads (L)" > |
| 2 | 430 <filter>library['unaligned_file'] is True</filter> |
| 0 | 431 <actions> |
| 432 <action type="format"> | |
| 433 <option type="from_param" name="library.input_1" param_attribute="ext" /> | |
| 434 </action> | |
| 435 </actions> | |
| 436 </data> | |
| 437 <data format="fastqsanger" name="output_unaligned_reads_r" label="${tool.name} on ${on_string}: unaligned reads (R)"> | |
| 2 | 438 <filter>( library['type'] == "paired" or library['type'] == "paired_collection" ) and library['unaligned_file'] is True</filter> |
| 0 | 439 <actions> |
| 440 <action type="format"> | |
| 441 <option type="from_param" name="library.input_1" param_attribute="ext" /> | |
| 442 </action> | |
| 443 </actions> | |
| 444 </data> | |
| 2 | 445 |
| 3 | 446 <data format="bam" name="output" label="${tool.name} on ${on_string}: aligned reads (sorted BAM)"> |
| 0 | 447 <actions> |
| 448 <conditional name="reference_genome.source"> | |
| 449 <when value="indexed"> | |
| 450 <action type="metadata" name="dbkey"> | |
| 451 <option type="from_data_table" name="bowtie2_indexes" column="1" offset="0"> | |
| 452 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/> | |
| 453 <filter type="param_value" ref="reference_genome.index" column="0"/> | |
| 454 </option> | |
| 455 </action> | |
| 456 </when> | |
| 457 <when value="history"> | |
| 458 <action type="metadata" name="dbkey"> | |
| 459 <option type="from_param" name="reference_genome.own_file" param_attribute="dbkey" /> | |
| 460 </action> | |
| 461 </when> | |
| 462 </conditional> | |
| 463 </actions> | |
| 464 </data> | |
| 3 | 465 |
| 0 | 466 </outputs> |
| 467 | |
| 468 <tests> | |
| 469 <test> | |
| 470 <!-- basic test on single paired default run --> | |
| 2 | 471 <param name="type" value="paired"/> |
| 0 | 472 <param name="selection" value="no"/> |
| 2 | 473 <param name="paired_options_selector" value="no"/> |
| 0 | 474 <param name="unaligned_file" value="false"/> |
| 2 | 475 <param name="analysis_type_selector" value="simple"/> |
| 0 | 476 <param name="source" value="history" /> |
| 2 | 477 <param name="input_1" value="bowtie2-fq1.fq" ftype="fastqsanger"/> |
| 478 <param name="input_2" value="bowtie2-fq2.fq" ftype="fastqsanger"/> | |
| 479 <param name="own_file" value="bowtie2-ref.fasta" /> | |
| 480 <output name="output" file="bowtie2-test1.bam" ftype="bam" lines_diff="2"/> | |
| 0 | 481 </test> |
| 482 </tests> | |
| 483 | |
| 484 <help> | |
| 2 | 485 |
| 0 | 486 **Bowtie2 Overview** |
| 487 | |
| 2 | 488 Bowtie2_ is an ultrafast and memory-efficient tool for aligning sequencing reads to long reference sequences. It is particularly good at aligning reads of about 50 up to 100s or 1,000s of characters to relatively long (e.g. mammalian) genomes. Bowtie 2 supports gapped, local, and paired-end alignment modes. Galaxy wrapper for Bowtie 2 outputs alignments in `BAM format`_, enabling interoperation with a large number of other tools available at this site. |
| 489 Majority of information in this page is derived from an excellent `Bowtie2 manual`_ written by Ben Langmead. | |
| 490 | |
| 491 .. _Bowtie2: http://bowtie-bio.sourceforge.net/bowtie2/ | |
| 492 .. _`Bowtie2 manual`: http://bowtie-bio.sourceforge.net/bowtie2/manual.shtml | |
| 493 .. _`BAM format`: http://samtools.github.io/hts-specs/SAMv1.pdf | |
| 494 | |
| 495 ----- | |
| 0 | 496 |
| 2 | 497 **Selecting reference genomes for Bowtie2** |
| 498 | |
| 499 Galaxy wrapper for Bowtie2 allows you select between precomputed and user-defined indices for reference genomes using **Will you select a reference genome from your history or use a built-in index?** flag. This flag has two options: | |
| 0 | 500 |
| 2 | 501 1. **Use a built-in genome index** - when selected (this is default), Galaxy provides the user with **Select reference genome index** dropdown. Genomes listed in this dropdown have been pre-indexed with bowtie2-build utility and are ready to be mapped against. |
| 502 2. **Use a genome from the history and build index** - when selected, Galaxy provides the user with **Select reference genome sequence** dropdown. This dropdown is populated by all FASTA formatted files listed in your current history. If your genome of interest is uploaded into history it will be shown there. Selecting a genome from this dropdown will cause Galaxy to first transparently index it using bowtie2-build command, and then run mapping with bowtie2. | |
| 503 | |
| 504 If your genome of interest is not listed here you have two choices: | |
| 505 | |
| 506 1. Contact galaxy team using **Help->Support** link at the top of the interface and let us know that an index needs to be added | |
| 507 2. Upload your genome of interest as a FASTA file to Galaxy history and selected **Use a genome from the history and build index** option. | |
| 0 | 508 |
| 509 ------ | |
| 510 | |
| 2 | 511 .. class:: infomark |
| 512 | |
| 513 **Bowtie2 options** | |
| 514 | |
| 515 Galaxy wrapper for Bowtie2 implements most but not all options available through the command line. Supported options are described below. | |
| 516 | |
| 517 ----- | |
| 518 | |
| 0 | 519 **Inputs** |
| 520 | |
| 521 Bowtie 2 accepts files in Sanger FASTQ format (single or pair-end). Use the FASTQ Groomer to prepare your files. | |
| 522 | |
| 523 ------ | |
| 524 | |
| 2 | 525 **Input options**:: |
| 526 | |
| 527 -s/--skip <int> | |
| 528 Skip (i.e. do not align) the first `<int>` reads or pairs in the input. | |
| 529 | |
| 530 -u/--qupto <int> | |
| 531 Align the first `<int>` reads or read pairs from the input (after the | |
| 532 `-s`/`--skip` reads or pairs have been skipped), then stop. Default: no limit. | |
| 533 | |
| 534 -5/--trim5 <int> | |
| 535 Trim `<int>` bases from 5' (left) end of each read before alignment (default: 0). | |
| 0 | 536 |
| 2 | 537 -3/--trim3 <int> |
| 538 Trim `<int>` bases from 3' (right) end of each read before alignment (default: 0). | |
| 539 | |
| 540 --phred33 | |
| 541 Input qualities are ASCII chars equal to the Phred quality plus 33. This is | |
| 542 also called the "Phred+33" encoding, which is used by the very latest Illumina | |
| 543 pipelines. | |
| 544 | |
| 545 --phred64 | |
| 3 | 546 Input qualities are ASCII chars equal to the Phred quality plus 64. This is |
| 2 | 547 also called the "Phred+64" encoding. |
| 0 | 548 |
| 2 | 549 --solexa-quals |
| 550 Convert input qualities from Solexa Phred quality (which can be negative) to | |
| 551 Phred Phred quality (which can't). This scheme was used in older Illumina GA | |
| 552 Pipeline versions (prior to 1.3). Default: off. | |
| 553 | |
| 554 --int-quals | |
| 555 Quality values are represented in the read input file as space-separated ASCII integers, e.g., `40 40 30 40`..., rather than ASCII characters, e.g., `II?I`.... | |
| 3 | 556 Integers are treated as being on the Phred quality scale unless |
| 2 | 557 `--solexa-quals` is also specified. Default: off. |
| 558 | |
| 559 ------ | |
| 560 | |
| 561 **Presets in `--end-to-end` mode**:: | |
| 562 | |
| 563 --very-fast | |
| 564 Same as: `-D 5 -R 1 -N 0 -L 22 -i S,0,2.50` | |
| 565 | |
| 566 --fast | |
| 567 Same as: `-D 10 -R 2 -N 0 -L 22 -i S,0,2.50` | |
| 568 | |
| 569 --sensitive | |
| 570 Same as: `-D 15 -R 2 -L 22 -i S,1,1.15` (default in `--end-to-end` mode) | |
| 571 | |
| 572 --very-sensitive | |
| 573 Same as: `-D 20 -R 3 -N 0 -L 20 -i S,1,0.50` | |
| 0 | 574 |
| 575 ------ | |
| 576 | |
| 2 | 577 **Presets options in `--local` mode**:: |
| 0 | 578 |
| 2 | 579 --very-fast-local |
| 580 Same as: `-D 5 -R 1 -N 0 -L 25 -i S,1,2.00` | |
| 0 | 581 |
| 2 | 582 --fast-local |
| 583 Same as: `-D 10 -R 2 -N 0 -L 22 -i S,1,1.75` | |
| 0 | 584 |
| 2 | 585 --sensitive-local |
| 586 Same as: `-D 15 -R 2 -N 0 -L 20 -i S,1,0.75` (default in `--local` mode) | |
| 0 | 587 |
| 2 | 588 --very-sensitive-local |
| 589 Same as: `-D 20 -R 3 -N 0 -L 20 -i S,1,0.50` | |
| 590 | |
| 0 | 591 ------ |
| 592 | |
| 2 | 593 **Alignment options**:: |
| 594 | |
| 595 -N <int> | |
| 3 | 596 Sets the number of mismatches to allowed in a seed alignment during multiseed |
| 597 alignment. Can be set to 0 or 1. Setting this higher makes alignment slower | |
| 2 | 598 (often much slower) but increases sensitivity. Default: 0. |
| 599 | |
| 600 -L <int> | |
| 3 | 601 Sets the length of the seed substrings to align during multiseed alignment. |
| 602 Smaller values make alignment slower but more sensitive. Default: the | |
| 603 `--sensitive` preset is used by default, which sets `-L` to 22 in | |
| 604 `--end-to-end` mode and to 20 in `--local` mode. | |
| 2 | 605 |
| 606 -i <func> | |
| 607 Sets a function governing the interval between seed substrings to use during | |
| 3 | 608 multiseed alignment. For instance, if the read has 30 characers, and seed |
| 2 | 609 length is 10, and the seed interval is 6, the seeds extracted will be: |
| 610 | |
| 611 Read: TAGCTACGCTCTACGCTATCATGCATAAAC | |
| 612 Seed 1 fw: TAGCTACGCT | |
| 613 Seed 1 rc: AGCGTAGCTA | |
| 614 Seed 2 fw: CGCTCTACGC | |
| 615 Seed 2 rc: GCGTAGAGCG | |
| 616 Seed 3 fw: ACGCTATCAT | |
| 617 Seed 3 rc: ATGATAGCGT | |
| 618 Seed 4 fw: TCATGCATAA | |
| 619 Seed 4 rc: TTATGCATGA | |
| 620 | |
| 621 Since it's best to use longer intervals for longer reads, this parameter sets | |
| 622 the interval as a function of the read length, rather than a single | |
| 623 one-size-fits-all number. For instance, specifying `-i S,1,2.5` sets the | |
| 624 interval function `f` to `f(x) = 1 + 2.5 * sqrt(x)`, where x is the read length. | |
| 3 | 625 If the function returns a result less than |
| 2 | 626 1, it is rounded up to 1. Default: the `--sensitive` preset is used by |
| 627 default, which sets `-i` to `S,1,1.15` in `--end-to-end` mode to `-i S,1,0.75` | |
| 628 in `--local` mode. | |
| 629 | |
| 630 --n-ceil <func> | |
| 631 Sets a function governing the maximum number of ambiguous characters (usually | |
| 632 `N`s and/or `.`s) allowed in a read as a function of read length. For instance, | |
| 633 specifying `-L,0,0.15` sets the N-ceiling function `f` to `f(x) = 0 + 0.15 * x`, | |
| 3 | 634 where x is the read length. Reads exceeding this ceiling are filtered out. |
| 635 Default: `L,0,0.15`. | |
| 2 | 636 |
| 637 --dpad <int> | |
| 638 "Pads" dynamic programming problems by `<int>` columns on either side to allow | |
| 639 gaps. Default: 15. | |
| 640 | |
| 641 --gbar <int> | |
| 642 Disallow gaps within `<int>` positions of the beginning or end of the read. | |
| 643 Default: 4. | |
| 644 | |
| 645 --ignore-quals | |
| 646 When calculating a mismatch penalty, always consider the quality value at the | |
| 647 mismatched position to be the highest possible, regardless of the actual value. | |
| 648 I.e. input is treated as though all quality values are high. This is also the | |
| 649 default behavior when the input doesn't specify quality values (e.g. in `-f`, | |
| 650 `-r`, or `-c` modes). | |
| 0 | 651 |
| 2 | 652 --nofw/--norc |
| 653 If `--nofw` is specified, `bowtie2` will not attempt to align unpaired reads to | |
| 654 the forward (Watson) reference strand. If `--norc` is specified, `bowtie2` will | |
| 655 not attempt to align unpaired reads against the reverse-complement (Crick) | |
| 656 reference strand. In paired-end mode, `--nofw` and `--norc` pertain to the | |
| 657 fragments; i.e. specifying `--nofw` causes `bowtie2` to explore only those | |
| 658 paired-end configurations corresponding to fragments from the reverse-complement | |
| 659 (Crick) strand. Default: both strands enabled. | |
| 660 | |
| 661 --no-1mm-upfront | |
| 662 By default, Bowtie 2 will attempt to find either an exact or a 1-mismatch | |
| 3 | 663 end-to-end alignment for the read *before* trying the multiseed heuristic. Such |
| 2 | 664 alignments can be found very quickly, and many short read alignments have exact or |
| 665 near-exact end-to-end alignments. However, this can lead to unexpected | |
| 3 | 666 alignments when the user also sets options governing the multiseed heuristic, |
| 2 | 667 like `-L` and `-N`. For instance, if the user specifies `-N 0` and `-L` equal |
| 668 to the length of the read, the user will be surprised to find 1-mismatch alignments | |
| 669 reported. This option prevents Bowtie 2 from searching for 1-mismatch end-to-end | |
| 3 | 670 alignments before using the multiseed heuristic, which leads to the expected |
| 2 | 671 behavior when combined with options such as `-L` and `-N`. This comes at the |
| 672 expense of speed. | |
| 673 | |
| 674 --end-to-end | |
| 675 In this mode, Bowtie 2 requires that the entire read align from one end to the | |
| 676 other, without any trimming (or "soft clipping") of characters from either end. | |
| 677 The match bonus `--ma` always equals 0 in this mode, so all alignment scores | |
| 678 are less than or equal to 0, and the greatest possible alignment score is 0. | |
| 679 This is mutually exclusive with `--local`. `--end-to-end` is the default mode. | |
| 0 | 680 |
| 2 | 681 --local |
| 682 In this mode, Bowtie 2 does not require that the entire read align from one end | |
| 683 to the other. Rather, some characters may be omitted ("soft clipped") from the | |
| 684 ends in order to achieve the greatest possible alignment score. The match bonus | |
| 685 `--ma` is used in this mode, and the best possible alignment score is equal to | |
| 686 the match bonus (`--ma`) times the length of the read. Specifying `--local` | |
| 687 and one of the presets (e.g. `--local --very-fast`) is equivalent to specifying | |
| 688 the local version of the preset (`--very-fast-local`). This is mutually | |
| 689 exclusive with `--end-to-end`. `--end-to-end` is the default mode. | |
| 690 | |
| 691 ----- | |
| 692 | |
| 693 **Scoring options**:: | |
| 694 | |
| 695 --ma <int> | |
| 696 Sets the match bonus. In `--local` mode `<int>` is added to the alignment | |
| 697 score for each position where a read character aligns to a reference character | |
| 698 and the characters match. Not used in `--end-to-end` mode. Default: 2. | |
| 699 | |
| 700 --mp MX,MN | |
| 701 Sets the maximum (`MX`) and minimum (`MN`) mismatch penalties, both integers. A | |
| 702 number less than or equal to `MX` and greater than or equal to `MN` is | |
| 703 subtracted from the alignment score for each position where a read character | |
| 704 aligns to a reference character, the characters do not match, and neither is an | |
| 705 `N`. If `--ignore-quals` is specified, the number subtracted quals `MX`. | |
| 706 Otherwise, the number subtracted is `MN + floor( (MX-MN)(MIN(Q, 40.0)/40.0) )` | |
| 707 where Q is the Phred quality value. Default: `MX` = 6, `MN` = 2. | |
| 708 | |
| 709 --np <int> | |
| 710 Sets penalty for positions where the read, reference, or both, contain an | |
| 711 ambiguous character such as `N`. Default: 1. | |
| 712 | |
| 713 --rdg <int1>,<int2> | |
| 714 Sets the read gap open (`<int1>`) and extend (`<int2>`) penalties. A read gap of | |
| 715 length N gets a penalty of `<int1>` + N * `<int2>`. Default: 5, 3. | |
| 716 | |
| 717 --rfg <int1>,<int2> | |
| 718 Sets the reference gap open (`<int1>`) and extend (`<int2>`) penalties. A | |
| 719 reference gap of length N gets a penalty of `<int1>` + N * `<int2>`. Default: | |
| 720 5, 3. | |
| 0 | 721 |
| 2 | 722 --score-min <func> |
| 723 Sets a function governing the minimum alignment score needed for an alignment to | |
| 724 be considered "valid" (i.e. good enough to report). This is a function of read | |
| 725 length. For instance, specifying `L,0,-0.6` sets the minimum-score function `f` | |
| 3 | 726 to `f(x) = 0 + -0.6 * x`, where `x` is the read length. The default in `--end-to-end` mode is `L,-0.6,-0.6` and |
| 2 | 727 the default in `--local` mode is `G,20,8`. |
| 728 | |
| 729 ----- | |
| 730 | |
| 731 **Reporting options**:: | |
| 732 | |
| 733 -k <int> | |
| 734 By default, `bowtie2` searches for distinct, valid alignments for each read. | |
| 735 When it finds a valid alignment, it continues looking for alignments that are | |
| 736 nearly as good or better. The best alignment found is reported (randomly | |
| 737 selected from among best if tied). Information about the best alignments is | |
| 738 used to estimate mapping quality and to set SAM optional fields, such as | |
| 739 `AS:i` and `XS:i`. | |
| 740 | |
| 741 When `-k` is specified, however, `bowtie2` behaves differently. Instead, it | |
| 742 searches for at most `<int>` distinct, valid alignments for each read. The | |
| 743 search terminates when it can't find more distinct valid alignments, or when it | |
| 744 finds `<int>`, whichever happens first. All alignments found are reported in | |
| 745 descending order by alignment score. The alignment score for a paired-end | |
| 746 alignment equals the sum of the alignment scores of the individual mates. Each | |
| 747 reported read or pair alignment beyond the first has the SAM 'secondary' bit | |
| 748 (which equals 256) set in its FLAGS field. For reads that have more than | |
| 749 `<int>` distinct, valid alignments, `bowtie2` does not guarantee that the | |
| 750 `<int>` alignments reported are the best possible in terms of alignment score. | |
| 751 `-k` is mutually exclusive with `-a`. | |
| 0 | 752 |
| 2 | 753 Note: Bowtie 2 is not designed with large values for `-k` in mind, and when |
| 754 aligning reads to long, repetitive genomes large `-k` can be very, very slow. | |
| 755 | |
| 756 -a | |
| 757 Like `-k` but with no upper limit on number of alignments to search for. `-a` | |
| 758 is mutually exclusive with `-k`. | |
| 759 | |
| 760 Note: Bowtie 2 is not designed with `-a` mode in mind, and when | |
| 761 aligning reads to long, repetitive genomes this mode can be very, very slow. | |
| 762 | |
| 763 ----- | |
| 764 | |
| 765 **Effort options**:: | |
| 766 | |
| 767 -D <int> | |
| 768 Up to `<int>` consecutive seed extension attempts can "fail" before Bowtie 2 | |
| 769 moves on, using the alignments found so far. A seed extension "fails" if it | |
| 770 does not yield a new best or a new second-best alignment. This limit is | |
| 771 automatically adjusted up when -k or -a are specified. Default: 15. | |
| 772 | |
| 773 -R <int> | |
| 774 `<int>` is the maximum number of times Bowtie 2 will "re-seed" reads with | |
| 775 repetitive seeds. When "re-seeding," Bowtie 2 simply chooses a new set of reads | |
| 776 (same length, same number of mismatches allowed) at different offsets and | |
| 777 searches for more alignments. A read is considered to have repetitive seeds if | |
| 778 the total number of seed hits divided by the number of seeds that aligned at | |
| 779 least once is greater than 300. Default: 2. | |
| 780 | |
| 781 ----- | |
| 782 | |
| 783 **Paired-end options**:: | |
| 0 | 784 |
| 2 | 785 -I/--minins <int> |
| 786 The minimum fragment length for valid paired-end alignments. E.g. if `-I 60` is | |
| 787 specified and a paired-end alignment consists of two 20-bp alignments in the | |
| 788 appropriate orientation with a 20-bp gap between them, that alignment is | |
| 789 considered valid (as long as `-X` is also satisfied). A 19-bp gap would not | |
| 790 be valid in that case. If trimming options `-3` or `-5` are also used, the | |
| 791 `-I` constraint is applied with respect to the untrimmed mates. | |
| 792 | |
| 793 The larger the difference between `-I` and `-X`, the slower Bowtie 2 will | |
| 794 run. This is because larger differences bewteen `-I` and `-X` require that | |
| 795 Bowtie 2 scan a larger window to determine if a concordant alignment exists. | |
| 796 For typical fragment length ranges (200 to 400 nucleotides), Bowtie 2 is very | |
| 797 efficient. | |
| 798 | |
| 799 Default: 0 (essentially imposing no minimum) | |
| 800 | |
| 801 -X/--maxins <int> | |
| 802 The maximum fragment length for valid paired-end alignments. E.g. if `-X 100` | |
| 803 is specified and a paired-end alignment consists of two 20-bp alignments in the | |
| 804 proper orientation with a 60-bp gap between them, that alignment is considered | |
| 805 valid (as long as `-I` is also satisfied). A 61-bp gap would not be valid in | |
| 806 that case. If trimming options `-3` or `-5` are also used, the `-X` | |
| 807 constraint is applied with respect to the untrimmed mates, not the trimmed | |
| 808 mates. | |
| 809 | |
| 810 The larger the difference between `-I` and `-X`, the slower Bowtie 2 will | |
| 811 run. This is because larger differences bewteen `-I` and `-X` require that | |
| 812 Bowtie 2 scan a larger window to determine if a concordant alignment exists. | |
| 813 For typical fragment length ranges (200 to 400 nucleotides), Bowtie 2 is very | |
| 814 efficient. | |
| 815 | |
| 816 Default: 500. | |
| 0 | 817 |
| 2 | 818 --fr/--rf/--ff |
| 819 The upstream/downstream mate orientations for a valid paired-end alignment | |
| 820 against the forward reference strand. E.g., if `--fr` is specified and there is | |
| 821 a candidate paired-end alignment where mate 1 appears upstream of the reverse | |
| 822 complement of mate 2 and the fragment length constraints (`-I` and `-X`) are | |
| 823 met, that alignment is valid. Also, if mate 2 appears upstream of the reverse | |
| 824 complement of mate 1 and all other constraints are met, that too is valid. | |
| 825 `--rf` likewise requires that an upstream mate1 be reverse-complemented and a | |
| 826 downstream mate2 be forward-oriented. ` --ff` requires both an upstream mate 1 | |
| 827 and a downstream mate 2 to be forward-oriented. Default: `--fr` (appropriate | |
| 828 for Illumina's Paired-end Sequencing Assay). | |
| 829 | |
| 830 --no-mixed | |
| 831 By default, when `bowtie2` cannot find a concordant or discordant alignment for | |
| 832 a pair, it then tries to find alignments for the individual mates. This option | |
| 833 disables that behavior. | |
| 0 | 834 |
| 2 | 835 --no-discordant |
| 836 By default, `bowtie2` looks for discordant alignments if it cannot find any | |
| 837 concordant alignments. A discordant alignment is an alignment where both mates | |
| 838 align uniquely, but that does not satisfy the paired-end constraints | |
| 839 (`--fr`/`--rf`/`--ff`, `-I`, `-X`). This option disables that behavior. | |
| 840 | |
| 841 --dovetail | |
| 842 If the mates "dovetail", that is if one mate alignment extends past the | |
| 843 beginning of the other such that the wrong mate begins upstream, consider that | |
| 3 | 844 to be concordant. Default: mates cannot dovetail in a concordant alignment. |
| 2 | 845 |
| 846 --no-contain | |
| 847 If one mate alignment contains the other, consider that to be non-concordant. | |
| 3 | 848 Default: a mate can contain the other in a concordant alignment. |
| 2 | 849 |
| 850 --no-overlap | |
| 851 If one mate alignment overlaps the other at all, consider that to be | |
| 3 | 852 non-concordant. Default: mates can overlap in a concordant alignment. |
| 2 | 853 |
| 0 | 854 ------ |
| 855 | |
| 2 | 856 **SAM options**:: |
| 0 | 857 |
| 2 | 858 --rg-id <text> |
| 859 Set the read group ID to `<text>`. This causes the SAM `@RG` header line to be | |
| 860 printed, with `<text>` as the value associated with the `ID:` tag. It also | |
| 861 causes the `RG:Z:` extra field to be attached to each SAM output record, with | |
| 862 value set to `<text>`. | |
| 0 | 863 |
| 2 | 864 --rg <text> |
| 865 Add `<text>` (usually of the form `TAG:VAL`, e.g. `SM:Pool1`) as a field on the | |
| 866 `@RG` header line. Note: in order for the `@RG` line to appear, `--rg-id` | |
| 3 | 867 must also be specified. This is because the `ID` tag is required by the SAM |
| 868 Specification. Specify `--rg` multiple times to set multiple fields. See the | |
| 869 SAM Specification for details about what fields are legal. | |
| 0 | 870 |
| 2 | 871 --omit-sec-seq |
| 872 When printing secondary alignments, Bowtie 2 by default will write out the `SEQ` | |
| 873 and `QUAL` strings. Specifying this option causes Bowtie 2 to print an asterix | |
| 874 in those fields instead. | |
| 875 | |
| 876 ----- | |
| 0 | 877 |
| 2 | 878 **Other options**:: |
| 0 | 879 |
| 2 | 880 --reorder |
| 881 Guarantees that output SAM records are printed in an order corresponding to the | |
| 882 order of the reads in the original input file, even when `-p` is set greater | |
| 883 than 1. Specifying `--reorder` and setting `-p` greater than 1 causes Bowtie | |
| 884 2 to run somewhat slower and use somewhat more memory then if `--reorder` were | |
| 885 not specified. Has no effect if `-p` is set to 1, since output order will | |
| 886 naturally correspond to input order in that case. | |
| 0 | 887 |
| 2 | 888 --seed <int> |
| 889 Use `<int>` as the seed for pseudo-random number generator. Default: 0. | |
| 0 | 890 |
| 2 | 891 --non-deterministic |
| 892 Normally, Bowtie 2 re-initializes its pseudo-random generator for each read. It | |
| 893 seeds the generator with a number derived from (a) the read name, (b) the | |
| 894 nucleotide sequence, (c) the quality sequence, (d) the value of the `--seed` | |
| 895 option. This means that if two reads are identical (same name, same | |
| 896 nucleotides, same qualities) Bowtie 2 will find and report the same alignment(s) | |
| 897 for both, even if there was ambiguity. When `--non-deterministic` is specified, | |
| 898 Bowtie 2 re-initializes its pseudo-random generator for each read using the | |
| 899 current time. This means that Bowtie 2 will not necessarily report the same | |
| 900 alignment for two identical reads. This is counter-intuitive for some users, | |
| 901 but might be more appropriate in situations where the input consists of many | |
| 902 identical reads. | |
| 0 | 903 |
| 904 </help> | |
| 2 | 905 <citations> |
| 906 <citation type="doi">10.1186/gb-2009-10-3-r25</citation> | |
| 907 <citation type="doi">10.1038/nmeth.1923</citation> | |
| 908 </citations> | |
| 0 | 909 </tool> |