Mercurial > repos > bgruening > bismark
annotate bismark_bowtie2_wrapper.xml @ 23:4084128e7cca draft
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/bismark commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
| author | bgruening |
|---|---|
| date | Wed, 02 Sep 2015 15:55:46 -0400 |
| parents | 047eb877b6f0 |
| children |
| rev | line source |
|---|---|
| 22 | 1 <tool id="bismark_bowtie2" name="Bismark" version="0.14.3"> |
| 18 | 2 <!-- Wrapper compatible with Bismark version 0.10 --> |
| 9 | 3 <description>bisulfite mapper (bowtie2)</description> |
| 4 <!--<version_command>bismark version</version_command>--> | |
| 5 <requirements> | |
| 18 | 6 <requirement type="package" version="0.1.19">samtools</requirement> |
| 22 | 7 <requirement type="package" version="2.2.5">bowtie2</requirement> |
| 9 | 8 </requirements> |
| 21 | 9 <stdio> |
| 10 <exit_code range="1:" /> | |
| 11 <exit_code range=":-1" /> | |
| 12 <regex match="Error:" /> | |
| 13 <regex match="Exception:" /> | |
| 14 </stdio> | |
| 9 | 15 <command interpreter="python"> |
| 21 | 16 <![CDATA[ |
| 9 | 17 bismark_wrapper.py |
| 21 | 18 |
| 9 | 19 ## Change this to accommodate the number of threads you have available. |
| 18 | 20 --num-threads "\${GALAXY_SLOTS:-24}" |
| 9 | 21 |
| 22 | 22 --bismark_path $__tool_directory__ |
| 9 | 23 |
| 24 --bowtie2 | |
| 25 | |
| 26 ## | |
| 27 ## Bismark Genome Preparation, if desired. | |
| 28 ## | |
| 29 | |
| 30 ## Handle reference file. | |
| 31 #if $refGenomeSource.genomeSource == "history": | |
| 32 --own-file=$refGenomeSource.ownFile | |
| 33 #else: | |
| 34 --indexes-path ${refGenomeSource.index.fields.path} | |
| 35 #end if | |
| 36 | |
| 37 | |
| 38 ## | |
| 39 ## Input parameters | |
| 40 ## | |
| 41 | |
| 42 #if $singlePaired.sPaired == "single": | |
| 43 --single-paired $singlePaired.input_singles | |
| 44 | |
| 45 #if $singlePaired.input_singles.ext == "fastqillumina": | |
| 46 --phred64-quals | |
| 47 --fastq | |
| 48 #elif $singlePaired.input_singles.ext == "fastqsanger": | |
| 49 --fastq | |
| 50 #elif $singlePaired.input_singles.ext == "fasta": | |
| 51 --fasta | |
| 52 #end if | |
| 53 #else: | |
| 18 | 54 --mate-paired |
| 55 #set $mate1 = list() | |
| 56 #set $mate2 = list() | |
| 57 #for $mate_pair in $singlePaired.mate_list | |
| 58 $mate1.append( str($mate_pair.input_mate1) ) | |
| 59 $mate2.append( str($mate_pair.input_mate2) ) | |
| 60 #end for | |
| 9 | 61 |
| 18 | 62 --mate1 #echo ','.join($mate1) |
| 63 --mate2 #echo ','.join($mate2) | |
| 64 | |
| 21 | 65 #for $mate_pair in $singlePaired.mate_list: |
| 66 #if $mate_pair.input_mate1.ext == "fastqillumina": | |
| 67 --phred64-quals | |
| 68 --fastq | |
| 69 #elif $mate_pair.input_mate1.ext == "fastqsanger": | |
| 70 --fastq | |
| 71 #elif $mate_pair.input_mate1.ext == "fasta": | |
| 72 --fasta | |
| 73 #end if | |
| 74 #break | |
| 75 #end for | |
| 9 | 76 |
| 77 -I $singlePaired.minInsert | |
| 78 -X $singlePaired.maxInsert | |
| 79 #end if | |
| 80 | |
| 18 | 81 #if $sort_bam: |
| 82 --sort-bam | |
| 83 #end if | |
| 9 | 84 |
| 85 ## for now hardcode the value for the required memory per thread in --best mode | |
| 86 --chunkmbs 512 | |
| 87 | |
| 88 | |
| 89 #if $params.settingsType == "custom": | |
| 90 | |
| 91 ## default 20 | |
| 92 --seed-len $params.seed_len | |
| 93 ## default 0 | |
| 94 --seed-mismatches $params.seed_mismatches | |
| 95 ## default 15 | |
| 96 --seed-extention-attempts $params.seed_extention_attempts | |
| 97 ## default 2 | |
| 98 --max-reseed $params.max_reseed | |
| 21 | 99 |
| 9 | 100 ## default 70 |
| 101 ##--maqerr $params.maqerr | |
| 102 | |
| 103 ## default unlimited | |
| 104 #if $params.qupto != 0: | |
| 105 --qupto $params.qupto | |
| 106 #end if | |
| 107 #if $params.skip_reads != 0: | |
| 108 --skip-reads $params.skip_reads | |
| 109 #end if | |
| 110 | |
| 111 ## if set, disable the original behaviour | |
| 112 $params.no_mixed | |
| 113 ## if set, disable the original behaviour | |
| 114 $params.no_discordant | |
| 115 | |
| 18 | 116 #if $params.bismark_stdout: |
| 117 --stdout $output_stdout | |
| 118 #end if | |
| 9 | 119 |
| 18 | 120 #if $params.isReportOutput: |
| 121 --output-report-file $report_file | |
| 122 #end if | |
| 9 | 123 |
|
23
4084128e7cca
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/bismark commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
bgruening
parents:
22
diff
changeset
|
124 $params.non_directional |
|
4084128e7cca
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/bismark commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
bgruening
parents:
22
diff
changeset
|
125 |
| 9 | 126 #end if |
| 127 | |
| 128 ## | |
| 129 ## Output parameters. | |
| 130 ## | |
| 131 --output $output | |
| 18 | 132 ##$suppress_header |
| 9 | 133 |
| 134 #if str( $singlePaired.sPaired ) == "single" | |
| 135 #if $output_unmapped_reads_l | |
| 136 --output-unmapped-reads $output_unmapped_reads_l | |
| 137 #end if | |
| 138 #if $output_suppressed_reads_l | |
| 139 --output-suppressed-reads $output_suppressed_reads_l | |
| 140 #end if | |
| 141 #else | |
| 142 #if $output_unmapped_reads_l and $output_unmapped_reads_r | |
| 143 --output-unmapped-reads-l $output_unmapped_reads_l | |
| 144 --output-unmapped-reads-r $output_unmapped_reads_r | |
| 145 #end if | |
| 146 #if $output_suppressed_reads_l and $output_suppressed_reads_l | |
| 147 --output-suppressed-reads-l $output_suppressed_reads_l | |
| 148 --output-suppressed-reads-r $output_suppressed_reads_r | |
| 149 #end if | |
| 150 #end if | |
| 151 | |
| 21 | 152 ]]> |
| 9 | 153 </command> |
| 154 <inputs> | |
| 155 <conditional name="refGenomeSource"> | |
| 156 <param name="genomeSource" 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"> | |
| 157 <option value="indexed">Use a built-in index</option> | |
| 158 <option value="history">Use one from the history</option> | |
| 159 </param> | |
| 160 <when value="indexed"> | |
| 161 <param name="index" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact your Galaxy admin"> | |
| 162 <options from_data_table="bowtie2_indexes"> | |
| 163 <filter type="sort_by" column="2"/> | |
| 164 <validator type="no_options" message="No indexes are available for the selected input dataset"/> | |
| 165 </options> | |
| 166 </param> | |
| 167 </when> <!-- build-in --> | |
| 168 <when value="history"> | |
| 169 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select the reference genome" /> | |
| 170 </when> <!-- history --> | |
| 171 </conditional> <!-- refGenomeSource --> | |
| 172 | |
| 173 <!-- Input Parameters --> | |
| 174 <conditional name="singlePaired"> | |
| 175 <param name="sPaired" type="select" label="Is this library mate-paired?"> | |
| 176 <option value="single">Single-end</option> | |
| 177 <option value="paired">Paired-end</option> | |
| 178 </param> | |
| 179 <when value="single"> | |
| 180 <param name="input_singles" type="data" format="fastqsanger,fastqillumina,fastq,fasta" label="FASTQ/FASTA file" help="FASTQ or FASTA files." /> | |
| 181 </when> | |
| 182 <when value="paired"> | |
| 18 | 183 <repeat name="mate_list" title="Paired End Pairs" min="1"> |
| 184 <param name="input_mate1" type="data" format="fastqsanger,fastqillumina,fastq,fasta" label="Mate pair 1" help="FASTQ or FASTA files." /> | |
| 185 <param name="input_mate2" type="data" format="fastqsanger,fastqillumina,fastq,fasta" label="Mate pair 2" help="FASTQ or FASTA files." /> | |
| 186 </repeat> | |
| 9 | 187 <param name="minInsert" type="integer" value="0" label="Minimum insert size for valid paired-end alignments" /> |
| 18 | 188 <param name="maxInsert" type="integer" value="500" label="Maximum insert size for valid paired-end alignments" /> |
| 9 | 189 </when> |
| 190 </conditional> | |
| 191 | |
| 18 | 192 <param name="sort_bam" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Sort BAM file by chromosomal position (not compatibile with methylation extractor)"/> |
| 9 | 193 |
| 194 <conditional name="params"> | |
| 195 <param name="settingsType" type="select" label="Bismark settings to use" help="You can use the default settings or set custom values for any of Bismark's parameters."> | |
| 196 <option value="default">Use Defaults</option> | |
| 197 <option value="custom">Full parameter list</option> | |
| 198 </param> | |
| 199 <when value="default" /> | |
| 200 <!-- Full/advanced params. --> | |
| 201 <when value="custom"> | |
| 202 <!-- -N --> | |
| 203 <param name="seed_mismatches" type="integer" value="0" label="Number of mismatches to be allowed in a seed alignment during multiseed alignment" /> | |
| 204 <!-- -L --> | |
| 205 <param name="seed_len" type="integer" value="20" label="Length of the seed substrings to align during multiseed alignment" /> | |
| 206 <!-- | |
| 207 <param name="maqerr" type="integer" value="70" label="Maximum permitted total of quality values at all mismatched read positions throughout the entire alignment, not just in the 'seed'." /> | |
| 208 --> | |
| 209 <!-- -D --> | |
| 210 <param name="seed_extention_attempts" type="integer" value="15" label="How many consecutive seed extension attempts can fail before Bowtie 2 moves on" /> | |
| 211 <!-- -R --> | |
| 212 <param name="max_reseed" type="integer" value="2" label="Maximum number of times Bowtie 2 will re-seed reads with repetitive seeds" /> | |
| 213 | |
| 214 <param name="qupto" type="integer" value="0" label="Only aligns the first N reads or read pairs from the input" help="Default is 0 and means 'no-limit'." /> | |
| 215 <param name="skip_reads" type="integer" value="0" label="Skip (i.e. do not align) the first N reads or read pairs from the input" /> | |
| 216 | |
| 18 | 217 <param name="no_discordant" type="boolean" truevalue="--no-discordant" falsevalue="" checked="false" label="Disable looking for discordant alignments if it cannot find any concordant alignments" help="" /> |
| 218 <param name="no_mixed" type="boolean" truevalue="--no-mixed" falsevalue="" checked="false" label="Disable Bowtie 2's behaviour to try to find alignments for the individual mates" help="" /> | |
| 9 | 219 |
| 18 | 220 <param name="suppressed_read_file" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Write ambiguous reads to an extra output file" help="Write all reads which produce more than one valid alignment with the same number of lowest mismatches or other reads that fail to align uniquely." /> |
| 221 <param name="unmapped_read_file" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Write all reads that could not be aligned to a file" /> | |
| 9 | 222 <!-- output Options --> |
| 18 | 223 <param name="bismark_stdout" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Write the bismark output and summary information to an extra file" /> |
| 224 <param name="isReportOutput" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Offer all report files concatenated in one file" /> | |
| 225 | |
|
23
4084128e7cca
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/bismark commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
bgruening
parents:
22
diff
changeset
|
226 <param name="non_directional" type="boolean" truevalue="--non_directional" falsevalue="" checked="false" label="Non strand-specific sequence library" |
|
4084128e7cca
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/bismark commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
bgruening
parents:
22
diff
changeset
|
227 help="The sequencing library was constructed in a non strand-specific manner, alignments to all four bisulfite strands will be reported." /> |
|
4084128e7cca
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/bismark commit 18df9e67efd4adafcde4eb9b62cd815e4afe9733-dirty
bgruening
parents:
22
diff
changeset
|
228 |
| 21 | 229 <!--end output options --> |
| 9 | 230 </when> <!-- full --> |
| 231 </conditional> <!-- params --> | |
| 18 | 232 <!-- |
| 233 <param name="suppress_header" type="boolean" truevalue="..suppress-header" falsevalue="" checked="false" label="Suppress the header in the output SAM file" help="Bowtie produces SAM with several lines of header information by default." /> | |
| 234 --> | |
| 9 | 235 </inputs> |
| 18 | 236 |
| 237 | |
| 9 | 238 <outputs> |
| 239 <data format="txt" name="report_file" label="${tool.name} on ${on_string}: Report"> | |
| 18 | 240 <filter> |
| 241 (( | |
| 242 params['settingsType'] == "custom" and | |
| 243 params['isReportOutput'] is True | |
| 244 )) | |
| 245 </filter> | |
| 9 | 246 </data> |
| 18 | 247 <data format="txt" name="output_stdout" label="${tool.name} on ${on_string}: Summary"> |
| 248 <filter> | |
| 249 (( | |
| 250 params['settingsType'] == "custom" and | |
| 251 params['bismark_stdout'] is True | |
| 252 )) | |
| 253 </filter> | |
| 254 </data> | |
| 255 | |
| 256 <data format="bam" name="output" label="${tool.name} on ${on_string}: mapped reads"> | |
| 9 | 257 <actions> |
| 258 <conditional name="refGenomeSource.genomeSource"> | |
| 259 <when value="indexed"> | |
| 260 <action type="metadata" name="dbkey"> | |
| 261 <option type="from_data_table" name="bowtie2_indexes" column="1" offset="0"> | |
| 262 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/> | |
| 263 <filter type="param_value" ref="refGenomeSource.index" column="0"/> | |
| 264 </option> | |
| 265 </action> | |
| 266 </when> | |
| 267 <when value="history"> | |
| 268 <action type="metadata" name="dbkey"> | |
| 269 <option type="from_param" name="refGenomeSource.ownFile" param_attribute="dbkey" /> | |
| 270 </action> | |
| 271 </when> | |
| 272 </conditional> | |
| 273 </actions> | |
| 274 </data> | |
| 275 | |
| 276 <data format="fastq" name="output_suppressed_reads_l" label="${tool.name} on ${on_string}: suppressed reads (L)"> | |
| 277 <filter> | |
| 278 (( | |
| 279 params['settingsType'] == "custom" and | |
| 280 params['suppressed_read_file'] is True | |
| 281 )) | |
| 282 </filter> | |
| 283 <actions> | |
| 284 <conditional name="singlePaired.sPaired"> | |
| 285 <when value="single"> | |
| 286 <action type="format"> | |
| 287 <option type="from_param" name="singlePaired.input_singles" param_attribute="ext" /> | |
| 288 </action> | |
| 289 </when> | |
| 290 <when value="paired"> | |
| 21 | 291 <!--action type="format"> |
| 18 | 292 <option type="from_param" name="singlePaired.mate_list[0].input_mate1" param_attribute="ext" /> |
| 21 | 293 </action--> |
| 9 | 294 </when> |
| 295 </conditional> | |
| 296 </actions> | |
| 297 </data> | |
| 298 | |
| 299 <data format="fastq" name="output_suppressed_reads_r" label="${tool.name} on ${on_string}: suppressed reads (R)"> | |
| 21 | 300 <filter> |
| 301 (( | |
| 302 singlePaired['sPaired'] == "paired" and | |
| 303 params['settingsType'] == "custom" and | |
| 304 params['suppressed_read_file'] is True | |
| 305 )) | |
| 306 </filter> | |
| 9 | 307 <actions> |
| 308 <conditional name="singlePaired.sPaired"> | |
| 309 <when value="single"> | |
| 310 <action type="format"> | |
| 311 <option type="from_param" name="singlePaired.input_singles" param_attribute="ext" /> | |
| 312 </action> | |
| 313 </when> | |
| 314 <when value="paired"> | |
| 21 | 315 <!--action type="format"> |
| 18 | 316 <option type="from_param" name="singlePaired.mate_list[0].input_mate1" param_attribute="ext" /> |
| 21 | 317 </action--> |
| 9 | 318 </when> |
| 319 </conditional> | |
| 320 </actions> | |
| 321 </data> | |
| 322 | |
| 323 <!-- Outout unmapped reads --> | |
| 324 <data format="fastq" name="output_unmapped_reads_l" label="${tool.name} on ${on_string}: unmapped reads (L)"> | |
| 325 <filter> | |
| 326 (( | |
| 327 params['settingsType'] == "custom" and | |
| 328 params['unmapped_read_file'] is True | |
| 329 )) | |
| 330 </filter> | |
| 331 <actions> | |
| 332 <conditional name="singlePaired.sPaired"> | |
| 333 <when value="single"> | |
| 334 <action type="format"> | |
| 335 <option type="from_param" name="singlePaired.input_singles" param_attribute="ext" /> | |
| 336 </action> | |
| 337 </when> | |
| 338 <when value="paired"> | |
| 21 | 339 <!--action type="format"> |
| 18 | 340 <option type="from_param" name="singlePaired.mate_list[0].input_mate1" param_attribute="ext" /> |
| 21 | 341 </action--> |
| 9 | 342 </when> |
| 343 </conditional> | |
| 344 </actions> | |
| 345 </data> | |
| 18 | 346 |
| 9 | 347 <data format="fastq" name="output_unmapped_reads_r" label="${tool.name} on ${on_string}: unmapped reads (R)"> |
| 21 | 348 <filter> |
| 349 (( | |
| 350 singlePaired['sPaired'] == "paired" and | |
| 351 params['settingsType'] == "custom" and | |
| 352 params['unmapped_read_file'] is True | |
| 353 )) | |
| 354 </filter> | |
| 9 | 355 <actions> |
| 356 <conditional name="singlePaired.sPaired"> | |
| 357 <when value="single"> | |
| 358 <action type="format"> | |
| 359 <option type="from_param" name="singlePaired.input_singles" param_attribute="ext" /> | |
| 360 </action> | |
| 361 </when> | |
| 362 <when value="paired"> | |
| 21 | 363 <!--action type="format"> |
| 18 | 364 <option type="from_param" name="singlePaired.mate_list[0].input_mate1" param_attribute="ext" /> |
| 21 | 365 </action--> |
| 9 | 366 </when> |
| 367 </conditional> | |
| 368 </actions> | |
| 369 </data> | |
| 370 </outputs> | |
| 371 | |
| 372 <tests> | |
| 373 </tests> | |
| 374 | |
| 375 <help> | |
| 21 | 376 <![CDATA[ |
| 9 | 377 |
| 378 **What it does** | |
| 379 | |
| 380 Bismark_ is a bisulfite mapper and methylation caller. Bismark takes in FastA or FastQ files and aligns the | |
| 381 reads to a specified bisulfite genome. Sequence reads are transformed into a bisulfite converted forward strand | |
| 382 version (C->T conversion) or into a bisulfite treated reverse strand (G->A conversion of the forward strand). | |
| 383 Each of these reads are then aligned to bisulfite treated forward strand index of a reference genome | |
| 384 (C->T converted) and a bisulfite treated reverse strand index of the genome (G->A conversion of the | |
| 18 | 385 forward strand, by doing this alignments will produce the same positions). These instances of Bowtie 2 |
| 9 | 386 are run in parallel. The sequence file(s) are then read in again sequence by sequence to pull out the original |
| 387 sequence from the genome and determine if there were any protected C's present or not. | |
| 388 | |
| 389 .. _Bismark: http://www.bioinformatics.babraham.ac.uk/projects/bismark/ | |
| 390 | |
| 391 As of version 0.7.0 Bismark will only run 2 alignment threads for OT and OB in parallel, the 4 strand mode can be | |
| 392 re-enabled by using non_directional mode. | |
| 393 | |
| 394 It is developed by Krueger F and Andrews SR. at the Babraham Institute. Krueger F, Andrews SR. (2011) Bismark: a flexible aligner and methylation caller for Bisulfite-Seq applications. Bioinformatics, 27, 1571-2. | |
| 395 | |
| 396 ------ | |
| 397 | |
| 398 **Know what you are doing** | |
| 399 | |
| 400 .. class:: warningmark | |
| 401 | |
| 402 There is no such thing (yet) as an automated gearshift in short read mapping. It is all like stick-shift driving in San Francisco. In other words = running this tool with default parameters will probably not give you meaningful results. A way to deal with this is to **understand** the parameters by carefully reading the `documentation`__ and experimenting. Fortunately, Galaxy makes experimenting easy. | |
| 403 | |
| 404 .. __: http://www.bioinformatics.babraham.ac.uk/projects/bismark/ | |
| 405 | |
| 18 | 406 |
| 407 .. class:: warningmark | |
| 408 | |
| 409 Make sure all your input reads are in the correct and same format. If thats not the case please adjust/convert the filetype with galaxy's build-in converters. | |
| 410 | |
| 9 | 411 ------ |
| 412 | |
| 413 **Input formats** | |
| 414 | |
| 415 Bismark accepts files in either Sanger FASTQ format (galaxy type *fastqsanger*), Illumina FASTQ format (galaxy type *fastqillumina*) or FASTA format (galaxy type *fasta*). Use the FASTQ Groomer to prepare your files. | |
| 416 | |
| 417 ------ | |
| 418 | |
| 419 **A Note on Built-in Reference Genomes** | |
| 420 | |
| 421 The default variant for all genomes is "Full", defined as all primary chromosomes (or scaffolds/contigs) including mitochondrial plus associated unmapped, plasmid, and other segments. When only one version of a genome is available in this tool, it represents the default "Full" variant. Some genomes will have more than one variant available. The "Canonical Male" or sometimes simply "Canonical" variant contains the primary chromosomes for a genome. For example a human "Canonical" variant contains chr1-chr22, chrX, chrY, and chrM. The "Canonical Female" variant contains the primary chromosomes excluding chrY. | |
| 422 | |
| 423 ------ | |
| 424 | |
| 425 The final output of Bismark is in SAM format by default. | |
| 426 | |
| 427 **Outputs** | |
| 428 | |
| 429 The output is in SAM format, and has the following columns:: | |
| 430 | |
| 431 Column Description | |
| 432 -------- -------------------------------------------------------- | |
| 433 1 QNAME seq-ID | |
| 21 | 434 2 FLAG this flag tries to take the strand a bisulfite read |
| 435 originated from into account | |
| 9 | 436 (this is different from ordinary DNA alignment flags!) |
| 437 3 RNAME chromosome | |
| 438 4 POS start position | |
| 439 5 MAPQ always 255 | |
| 440 6 CIGAR extended CIGAR string | |
| 441 7 MRNM Mate Reference sequence NaMe ('=' if same as RNAME) | |
| 442 8 MPOS 1-based Mate POSition | |
| 443 9 ISIZE Inferred insert SIZE | |
| 444 10 SEQ query SEQuence on the same strand as the reference | |
| 445 11 QUAL Phred33 scale | |
| 446 12 NM-tag edit distance to the reference) | |
| 21 | 447 13 XX-tag base-by-base mismatches to the reference. |
| 9 | 448 This does not include indels. |
| 449 14 XM-tag methylation call string | |
| 450 15 XR-tag read conversion state for the alignment | |
| 451 16 XG-tag genome conversion state for the alignment | |
| 21 | 452 |
| 9 | 453 |
| 454 Each read of paired-end alignments is written out in a separate line in the above format. | |
| 455 | |
| 456 | |
| 457 It looks like this (scroll sideways to see the entire example):: | |
| 458 | |
| 459 QNAME FLAG RNAME POS MAPQ CIAGR MRNM MPOS ISIZE SEQ QUAL OPT | |
| 460 HWI-EAS91_1_30788AAXX:1:1:1761:343 4 * 0 0 * * 0 0 AAAAAAANNAAAAAAAAAAAAAAAAAAAAAAAAAAACNNANNGAGTNGNNNNNNNGCTTCCCACAGNNCTGG hhhhhhh;;hhhhhhhhhhh^hOhhhhghhhfhhhgh;;h;;hhhh;h;;;;;;;hhhhhhghhhh;;Phhh | |
| 461 HWI-EAS91_1_30788AAXX:1:1:1578:331 4 * 0 0 * * 0 0 GTATAGANNAATAAGAAAAAAAAAAATGAAGACTTTCNNANNTCTGNANNNNNNNTCTTTTTTCAGNNGTAG hhhhhhh;;hhhhhhhhhhhhhhhhhhhhhhhhhhhh;;h;;hhhh;h;;;;;;;hhhhhhhhhhh;;hhVh | |
| 462 | |
| 463 ------- | |
| 464 | |
| 465 **Bismark settings** | |
| 466 | |
| 467 All of the options have a default value. You can change any of them. If any Bismark function is missing please contact the tool author or your Galaxy admin. | |
| 468 | |
| 469 ------ | |
| 470 | |
| 471 **Bismark parameter list** | |
| 472 | |
| 18 | 473 This is an exhaustive list of Bismark options. |
| 9 | 474 |
| 475 Input:: | |
| 476 | |
| 477 --singles A comma- or space-separated list of files containing the reads to be aligned (e.g. | |
| 478 lane1.fq,lane2.fq lane3.fq). Reads may be a mix of different lengths. Bismark will | |
| 479 produce one mapping result and one report file per input file. | |
| 480 | |
| 481 -1 mates1 Comma-separated list of files containing the #1 mates (filename usually includes | |
| 482 "_1"), e.g. flyA_1.fq,flyB_1.fq). Sequences specified with this option must | |
| 483 correspond file-for-file and read-for-read with those specified in mates2. | |
| 484 Reads may be a mix of different lengths. Bismark will produce one mapping result | |
| 485 and one report file per paired-end input file pair. | |
| 486 | |
| 487 -2 mates2 Comma-separated list of files containing the #2 mates (filename usually includes | |
| 488 "_2"), e.g. flyA_1.fq,flyB_1.fq). Sequences specified with this option must | |
| 489 correspond file-for-file and read-for-read with those specified in mates1. | |
| 490 Reads may be a mix of different lengths. | |
| 491 | |
| 492 -q/--fastq The query input files (specified as mate1,mate2 or singles are FASTQ | |
| 493 files (usually having extension .fg or .fastq). This is the default. See also | |
| 494 --solexa-quals. | |
| 495 | |
| 496 -f/--fasta The query input files (specified as mate1,mate2 or singles are FASTA | |
| 497 files (usually havin extension .fa, .mfa, .fna or similar). All quality values | |
| 498 are assumed to be 40 on the Phred scale. | |
| 499 | |
| 500 -s/--skip INT Skip (i.e. do not align) the first INT reads or read pairs from the input. | |
| 501 | |
| 502 -u/--upto INT Only aligns the first INT reads or read pairs from the input. Default: no limit. | |
| 503 | |
| 504 --phred33-quals FASTQ qualities are ASCII chars equal to the Phred quality plus 33. Default: on. | |
| 505 | |
| 506 --phred64-quals FASTQ qualities are ASCII chars equal to the Phred quality plus 64. Default: off. | |
| 507 | |
| 508 --solexa-quals Convert FASTQ qualities from solexa-scaled (which can be negative) to phred-scaled | |
| 21 | 509 (which can't). The formula for conversion is: |
| 9 | 510 phred-qual = 10 * log(1 + 10 ** (solexa-qual/10.0)) / log(10). Used with -q. This |
| 511 is usually the right option for use with (unconverted) reads emitted by the GA | |
| 512 Pipeline versions prior to 1.3. Works only for Bowtie 1. Default: off. | |
| 513 | |
| 514 --solexa1.3-quals Same as --phred64-quals. This is usually the right option for use with (unconverted) | |
| 515 reads emitted by GA Pipeline version 1.3 or later. Default: off. | |
| 516 | |
| 517 | |
| 518 Alignment:: | |
| 519 | |
| 520 -n/--seedmms INT The maximum number of mismatches permitted in the "seed", i.e. the first L base pairs | |
| 21 | 521 of the read (where L is set with -l/--seedlen). This may be 0, 1, 2 or 3 and the |
| 9 | 522 default is 1. This option is only available for Bowtie 1 (for Bowtie 2 see -N). |
| 523 | |
| 524 -l/--seedlen The "seed length"; i.e., the number of bases of the high quality end of the read to | |
| 525 which the -n ceiling applies. The default is 28. Bowtie (and thus Bismark) is faster for | |
| 526 larger values of -l. This option is only available for Bowtie 1 (for Bowtie 2 see -L). | |
| 527 | |
| 528 -e/--maqerr INT Maximum permitted total of quality values at all mismatched read positions throughout | |
| 529 the entire alignment, not just in the "seed". The default is 70. Like Maq, bowtie rounds | |
| 530 quality values to the nearest 10 and saturates at 30. This value is not relevant for | |
| 531 Bowtie 2. | |
| 532 | |
| 533 --chunkmbs INT The number of megabytes of memory a given thread is given to store path descriptors in | |
| 534 --best mode. Best-first search must keep track of many paths at once to ensure it is | |
| 535 always extending the path with the lowest cumulative cost. Bowtie tries to minimize the | |
| 536 memory impact of the descriptors, but they can still grow very large in some cases. If | |
| 537 you receive an error message saying that chunk memory has been exhausted in --best mode, | |
| 538 try adjusting this parameter up to dedicate more memory to the descriptors. This value | |
| 539 is not relevant for Bowtie 2. Default: 512. | |
| 540 | |
| 541 -I/--minins INT The minimum insert size for valid paired-end alignments. E.g. if -I 60 is specified and | |
| 542 a paired-end alignment consists of two 20-bp alignments in the appropriate orientation | |
| 543 with a 20-bp gap between them, that alignment is considered valid (as long as -X is also | |
| 544 satisfied). A 19-bp gap would not be valid in that case. Default: 0. | |
| 545 | |
| 546 -X/--maxins INT The maximum insert size for valid paired-end alignments. E.g. if -X 100 is specified and | |
| 547 a paired-end alignment consists of two 20-bp alignments in the proper orientation with a | |
| 548 60-bp gap between them, that alignment is considered valid (as long as -I is also satisfied). | |
| 549 A 61-bp gap would not be valid in that case. Default: 500. | |
| 550 | |
| 551 | |
| 552 | |
| 553 Output:: | |
| 554 | |
| 555 --non_directional The sequencing library was constructed in a non strand-specific manner, alignments to all four | |
| 556 bisulfite strands will be reported. Default: OFF. | |
| 557 | |
| 558 (The current Illumina protocol for BS-Seq is directional, in which case the strands complementary | |
| 559 to the original strands are merely theoretical and should not exist in reality. Specifying directional | |
| 560 alignments (which is the default) will only run 2 alignment threads to the original top (OT) | |
| 561 or bottom (OB) strands in parallel and report these alignments. This is the recommended option | |
| 562 for sprand-specific libraries). | |
| 563 | |
| 564 --sam-no-hd Suppress SAM header lines (starting with @). This might be useful when very large input files are | |
| 565 split up into several smaller files to run concurrently and the output files are to be merged. | |
| 566 | |
| 567 --quiet Print nothing besides alignments. | |
| 568 | |
| 569 --vanilla Performs bisulfite mapping with Bowtie 1 and prints the 'old' output (as in Bismark 0.5.X) instead | |
| 570 of SAM format output. | |
| 571 | |
| 572 -un/--unmapped Write all reads that could not be aligned to a file in the output directory. Written reads will | |
| 573 appear as they did in the input, without any translation of quality values that may have | |
| 574 taken place within Bowtie or Bismark. Paired-end reads will be written to two parallel files with _1 | |
| 575 and _2 inserted in their filenames, i.e. _unmapped_reads_1.txt and unmapped_reads_2.txt. Reads | |
| 576 with more than one valid alignment with the same number of lowest mismatches (ambiguous mapping) | |
| 577 are also written to _unmapped_reads.txt unless the option --ambiguous is specified as well. | |
| 578 | |
| 579 --ambiguous Write all reads which produce more than one valid alignment with the same number of lowest | |
| 580 mismatches or other reads that fail to align uniquely to a file in the output directory. | |
| 581 Written reads will appear as they did in the input, without any of the translation of quality | |
| 582 values that may have taken place within Bowtie or Bismark. Paired-end reads will be written to two | |
| 583 parallel files with _1 and _2 inserted in theit filenames, i.e. _ambiguous_reads_1.txt and | |
| 584 _ambiguous_reads_2.txt. These reads are not written to the file specified with --un. | |
| 585 | |
| 586 -o/--output_dir DIR Write all output files into this directory. By default the output files will be written into | |
| 587 the same folder as the input file(s). If the specified folder does not exist, Bismark will attempt | |
| 588 to create it first. The path to the output folder can be either relative or absolute. | |
| 589 | |
| 590 --temp_dir DIR Write temporary files to this directory instead of into the same directory as the input files. If | |
| 591 the specified folder does not exist, Bismark will attempt to create it first. The path to the | |
| 592 temporary folder can be either relative or absolute. | |
| 593 | |
| 594 ------ | |
| 595 | |
| 596 Bowtie 2 alignment options:: | |
| 597 | |
| 598 -N INT Sets the number of mismatches to allowed in a seed alignment during multiseed alignment. | |
| 599 Can be set to 0 or 1. Setting this higher makes alignment slower (often much slower) | |
| 600 but increases sensitivity. Default: 0. This option is only available for Bowtie 2 (for | |
| 601 Bowtie 1 see -n). | |
| 602 | |
| 603 -L INT Sets the length of the seed substrings to align during multiseed alignment. Smaller values | |
| 604 make alignment slower but more senstive. Default: the --sensitive preset of Bowtie 2 is | |
| 605 used by default, which sets -L to 20. This option is only available for Bowtie 2 (for | |
| 606 Bowtie 1 see -l). | |
| 607 | |
| 608 --ignore-quals When calculating a mismatch penalty, always consider the quality value at the mismatched | |
| 609 position to be the highest possible, regardless of the actual value. I.e. input is treated | |
| 610 as though all quality values are high. This is also the default behavior when the input | |
| 611 doesn't specify quality values (e.g. in -f mode). This option is invariable and on by default. | |
| 612 | |
| 613 | |
| 614 Bowtie 2 paired-end options:: | |
| 615 | |
| 616 --no-mixed This option disables Bowtie 2's behavior to try to find alignments for the individual mates if | |
| 617 it cannot find a concordant or discordant alignment for a pair. This option is invariable and | |
| 618 and on by default. | |
| 619 | |
| 620 --no-discordant Normally, Bowtie 2 looks for discordant alignments if it cannot find any concordant alignments. | |
| 621 A discordant alignment is an alignment where both mates align uniquely, but that does not | |
| 622 satisfy the paired-end constraints (--fr/--rf/--ff, -I, -X). This option disables that behavior | |
| 623 and it is on by default. | |
| 624 | |
| 625 | |
| 626 Bowtie 2 effort options:: | |
| 627 | |
| 628 -D INT Up to INT consecutive seed extension attempts can "fail" before Bowtie 2 moves on, using | |
| 629 the alignments found so far. A seed extension "fails" if it does not yield a new best or a | |
| 630 new second-best alignment. Default: 15. | |
| 631 | |
| 632 -R INT INT is the maximum number of times Bowtie 2 will "re-seed" reads with repetitive seeds. | |
| 633 When "re-seeding," Bowtie 2 simply chooses a new set of reads (same length, same number of | |
| 634 mismatches allowed) at different offsets and searches for more alignments. A read is considered | |
| 635 to have repetitive seeds if the total number of seed hits divided by the number of seeds | |
| 636 that aligned at least once is greater than 300. Default: 2. | |
| 637 | |
| 638 | |
| 639 Bowtie 2 Scoring options:: | |
| 640 | |
| 641 --score_min "func" Sets a function governing the minimum alignment score needed for an alignment to be considered | |
| 642 "valid" (i.e. good enough to report). This is a function of read length. For instance, specifying | |
| 643 L,0,-0.2 sets the minimum-score function f to f(x) = 0 + -0.2 * x, where x is the read length. | |
| 644 See also: setting function options at http://bowtie-bio.sourceforge.net/bowtie2. The default is | |
| 645 L,0,-0.2. | |
| 646 | |
| 647 | |
| 648 Bowtie 2 Reporting options:: | |
| 649 | |
| 650 --most_valid_alignments INT This used to be the Bowtie 2 parameter -M. As of Bowtie 2 version 2.0.0 beta7 the option -M is | |
| 651 deprecated. It will be removed in subsequent versions. What used to be called -M mode is still the | |
| 652 default mode, but adjusting the -M setting is deprecated. Use the -D and -R options to adjust the | |
| 653 effort expended to find valid alignments. | |
| 654 | |
| 655 For reference, this used to be the old (now deprecated) description of -M: | |
| 656 Bowtie 2 searches for at most INT+1 distinct, valid alignments for each read. The search terminates when it | |
| 657 can't find more distinct valid alignments, or when it finds INT+1 distinct alignments, whichever | |
| 658 happens first. Only the best alignment is reported. Information from the other alignments is used to | |
| 21 | 659 estimate mapping quality and to set SAM optional fields, such as AS:i and XS:i. Increasing -M makes |
| 9 | 660 Bowtie 2 slower, but increases the likelihood that it will pick the correct alignment for a read that |
| 661 aligns many places. For reads that have more than INT+1 distinct, valid alignments, Bowtie 2 does not | |
| 662 guarantee that the alignment reported is the best possible in terms of alignment score. -M is | |
| 663 always used and its default value is set to 10. | |
| 664 | |
| 21 | 665 ]]> |
| 9 | 666 </help> |
| 21 | 667 <citations> |
| 668 <citation type="doi">10.1093/bioinformatics/btr167</citation> | |
| 669 </citations> | |
| 9 | 670 </tool> |