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