annotate bwa_wrapper.xml @ 2:24fa4e22021a draft

Uploaded updated tool dependency definition.
author devteam
date Tue, 17 Dec 2013 09:20:58 -0500
parents 150b3fe44caa
children b4427dbb6ced
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
1 <tool id="bwa_wrapper" name="Map with BWA for Illumina" version="1.2.3">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
2 <requirements>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
3 <requirement type="package" version="0.5.9">bwa</requirement>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
4 </requirements>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
5 <description></description>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
6 <parallelism method="basic"></parallelism>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
7 <command interpreter="python">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
8 bwa_wrapper.py
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
9 --threads="4"
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
10
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
11 #if $input1.ext == "fastqillumina":
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
12 --illumina1.3
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
13 #end if
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
14
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
15 ## reference source
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
16 --fileSource="${genomeSource.refGenomeSource}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
17 #if $genomeSource.refGenomeSource == "history":
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
18 ##build index on the fly
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
19 --ref="${genomeSource.ownFile}"
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
20 --dbkey="${dbkey}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
21 #else:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
22 ##use precomputed indexes
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
23 --ref="${genomeSource.indices.fields.path}"
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
24 --do_not_build_index
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
25 #end if
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
26
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
27 ## input file(s)
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
28 --input1="${paired.input1}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
29 #if $paired.sPaired == "paired":
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
30 --input2="${paired.input2}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
31 #end if
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
32
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
33 ## output file
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
34 --output="${output}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
35
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
36 ## run parameters
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
37 --genAlignType="${paired.sPaired}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
38 --params="${params.source_select}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
39 #if $params.source_select != "pre_set":
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
40 --maxEditDist="${params.maxEditDist}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
41 --fracMissingAligns="${params.fracMissingAligns}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
42 --maxGapOpens="${params.maxGapOpens}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
43 --maxGapExtens="${params.maxGapExtens}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
44 --disallowLongDel="${params.disallowLongDel}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
45 --disallowIndel="${params.disallowIndel}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
46 --seed="${params.seed}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
47 --maxEditDistSeed="${params.maxEditDistSeed}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
48 --mismatchPenalty="${params.mismatchPenalty}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
49 --gapOpenPenalty="${params.gapOpenPenalty}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
50 --gapExtensPenalty="${params.gapExtensPenalty}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
51 --suboptAlign="${params.suboptAlign}"
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
52 --noIterSearch="${params.noIterSearch}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
53 --outputTopN="${params.outputTopN}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
54 --outputTopNDisc="${params.outputTopNDisc}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
55 --maxInsertSize="${params.maxInsertSize}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
56 --maxOccurPairing="${params.maxOccurPairing}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
57 #if $params.readGroup.specReadGroup == "yes"
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
58 --rgid="${params.readGroup.rgid}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
59 --rgcn="${params.readGroup.rgcn}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
60 --rgds="${params.readGroup.rgds}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
61 --rgdt="${params.readGroup.rgdt}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
62 --rgfo="${params.readGroup.rgfo}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
63 --rgks="${params.readGroup.rgks}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
64 --rglb="${params.readGroup.rglb}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
65 --rgpg="${params.readGroup.rgpg}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
66 --rgpi="${params.readGroup.rgpi}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
67 --rgpl="${params.readGroup.rgpl}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
68 --rgpu="${params.readGroup.rgpu}"
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
69 --rgsm="${params.readGroup.rgsm}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
70 #end if
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
71 #end if
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
72
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
73 ## suppress output SAM header
1
150b3fe44caa Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
74 --suppressHeader="${suppressHeader}"
0
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
75 </command>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
76 <inputs>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
77 <conditional name="genomeSource">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
78 <param name="refGenomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
79 <option value="indexed">Use a built-in index</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
80 <option value="history">Use one from the history</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
81 </param>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
82 <when value="indexed">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
83 <param name="indices" type="select" label="Select a reference genome">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
84 <options from_data_table="bwa_indexes">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
85 <filter type="sort_by" column="2" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
86 <validator type="no_options" message="No indexes are available" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
87 </options>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
88 </param>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
89 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
90 <when value="history">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
91 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select a reference from history" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
92 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
93 </conditional>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
94 <conditional name="paired">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
95 <param name="sPaired" type="select" label="Is this library mate-paired?">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
96 <option value="single">Single-end</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
97 <option value="paired">Paired-end</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
98 </param>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
99 <when value="single">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
100 <param name="input1" type="data" format="fastqsanger,fastqillumina" label="FASTQ file" help="FASTQ with either Sanger-scaled quality values (fastqsanger) or Illumina-scaled quality values (fastqillumina)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
101 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
102 <when value="paired">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
103 <param name="input1" type="data" format="fastqsanger,fastqillumina" label="Forward FASTQ file" help="FASTQ with either Sanger-scaled quality values (fastqsanger) or Illumina-scaled quality values (fastqillumina)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
104 <param name="input2" type="data" format="fastqsanger,fastqillumina" label="Reverse FASTQ file" help="FASTQ with either Sanger-scaled quality values (fastqsanger) or Illumina-scaled quality values (fastqillumina)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
105 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
106 </conditional>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
107 <conditional name="params">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
108 <param name="source_select" type="select" label="BWA settings to use" help="For most mapping needs use Commonly Used settings. If you want full control use Full Parameter List">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
109 <option value="pre_set">Commonly Used</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
110 <option value="full">Full Parameter List</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
111 </param>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
112 <when value="pre_set" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
113 <when value="full">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
114 <param name="maxEditDist" type="integer" value="0" label="Maximum edit distance (aln -n)" help="Enter this value OR a fraction of missing alignments, not both" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
115 <param name="fracMissingAligns" type="float" value="0.04" label="Fraction of missing alignments given 2% uniform base error rate (aln -n)" help="Enter this value OR maximum edit distance, not both" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
116 <param name="maxGapOpens" type="integer" value="1" label="Maximum number of gap opens (aln -o)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
117 <param name="maxGapExtens" type="integer" value="-1" label="Maximum number of gap extensions (aln -e)" help="-1 for k-difference mode (disallowing long gaps)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
118 <param name="disallowLongDel" type="integer" value="16" label="Disallow long deletion within [value] bp towards the 3'-end (aln -d)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
119 <param name="disallowIndel" type="integer" value="5" label="Disallow insertion/deletion within [value] bp towards the end (aln -i)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
120 <param name="seed" type="integer" value="-1" label="Number of first subsequences to take as seed (aln -l)" help="Enter -1 for infinity" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
121 <param name="maxEditDistSeed" type="integer" value="2" label="Maximum edit distance in the seed (aln -k)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
122 <param name="mismatchPenalty" type="integer" value="3" label="Mismatch penalty (aln -M)" help="BWA will not search for suboptimal hits with a score lower than [value]" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
123 <param name="gapOpenPenalty" type="integer" value="11" label="Gap open penalty (aln -O)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
124 <param name="gapExtensPenalty" type="integer" value="4" label="Gap extension penalty (aln -E)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
125 <param name="suboptAlign" type="integer" optional="True" label="Proceed with suboptimal alignments if there are no more than INT equally best hits. (aln -R)" help="For paired-end reads only. By default, BWA only searches for suboptimal alignments if the top hit is unique. Using this option has no effect on accuracy for single-end reads. It is mainly designed for improving the alignment accuracy of paired-end reads. However, the pairing procedure will be slowed down, especially for very short reads (~32bp)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
126 <param name="noIterSearch" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Disable iterative search (aln -N)" help="All hits with no more than maxDiff differences will be found. This mode is much slower than the default" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
127 <param name="outputTopN" type="integer" value="3" label="Maximum number of alignments to output in the XA tag for reads paired properly (samse/sampe -n)" help="If a read has more than INT hits, the XA tag will not be written" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
128 <param name="outputTopNDisc" type="integer" value="10" label="Maximum number of alignments to output in the XA tag for disconcordant read pairs (excluding singletons) (sampe -N)" help="For paired-end reads only. If a read has more than INT hits, the XA tag will not be written" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
129 <param name="maxInsertSize" type="integer" value="500" label="Maximum insert size for a read pair to be considered as being mapped properly (sampe -a)" help="For paired-end reads only. Only used when there are not enough good alignments to infer the distribution of insert sizes" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
130 <param name="maxOccurPairing" type="integer" value="100000" label="Maximum occurrences of a read for pairing (sampe -o)" help="For paired-end reads only. A read with more occurrences will be treated as a single-end read. Reducing this parameter helps faster pairing" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
131 <conditional name="readGroup">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
132 <param name="specReadGroup" type="select" label="Specify the read group for this file? (samse/sampe -r)">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
133 <option value="yes">Yes</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
134 <option value="no" selected="True">No</option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
135 </param>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
136 <when value="yes">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
137 <param name="rgid" type="text" size="25" label="Read group identifier (ID). Each @RG line must have a unique ID. The value of ID is used in the RG
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
138 tags of alignment records. Must be unique among all read groups in header section." help="Required if RG specified. Read group
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
139 IDs may be modified when merging SAM files in order to handle collisions." />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
140 <param name="rgcn" type="text" size="25" label="Sequencing center that produced the read (CN)" help="Optional" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
141 <param name="rgds" type="text" size="25" label="Description (DS)" help="Optional" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
142 <param name="rgdt" type="text" size="25" label="Date that run was produced (DT)" help="Optional. ISO8601 format date or date/time, like YYYY-MM-DD" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
143 <param name="rgfo" type="text" size="25" label="Flow order (FO). The array of nucleotide bases that correspond to the nucleotides used for each
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
144 flow of each read." help="Optional. Multi-base flows are encoded in IUPAC format, and non-nucleotide flows by
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
145 various other characters. Format : /\*|[ACMGRSVTWYHKDBN]+/" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
146 <param name="rgks" type="text" size="25" label="The array of nucleotide bases that correspond to the key sequence of each read (KS)" help="Optional" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
147 <param name="rglb" type="text" size="25" label="Library name (LB)" help="Required if RG specified" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
148 <param name="rgpg" type="text" size="25" label="Programs used for processing the read group (PG)" help="Optional" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
149 <param name="rgpi" type="text" size="25" label="Predicted median insert size (PI)" help="Optional" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
150 <param name="rgpl" type="text" size="25" label="Platform/technology used to produce the reads (PL)" help="Required if RG specified. Valid values : CAPILLARY, LS454, ILLUMINA,
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
151 SOLID, HELICOS, IONTORRENT and PACBIO" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
152 <param name="rgpu" type="text" size="25" label="Platform unit (PU)" help="Optional. Unique identifier (e.g. flowcell-barcode.lane for Illumina or slide for SOLiD)" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
153 <param name="rgsm" type="text" size="25" label="Sample (SM)" help="Required if RG specified. Use pool name where a pool is being sequenced" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
154 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
155 <when value="no" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
156 </conditional>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
157 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
158 </conditional>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
159 <param name="suppressHeader" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Suppress the header in the output SAM file" help="BWA produces SAM with several lines of header information" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
160 </inputs>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
161 <outputs>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
162 <data format="sam" name="output" label="${tool.name} on ${on_string}: mapped reads">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
163 <actions>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
164 <conditional name="genomeSource.refGenomeSource">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
165 <when value="indexed">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
166 <action type="metadata" name="dbkey">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
167 <option type="from_data_table" name="bwa_indexes" column="1">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
168 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
169 <filter type="param_value" ref="genomeSource.indices" column="0"/>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
170 </option>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
171 </action>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
172 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
173 <when value="history">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
174 <action type="metadata" name="dbkey">
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
175 <option type="from_param" name="genomeSource.ownFile" param_attribute="dbkey" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
176 </action>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
177 </when>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
178 </conditional>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
179 </actions>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
180 </data>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
181 </outputs>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
182 <tests>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
183 <test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
184 <!--
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
185 BWA commands:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
186 bwa aln -t 4 phiX.fasta test-data/bwa_wrapper_in1.fastqsanger > bwa_wrapper_out1.sai
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
187 bwa samse phiX.fasta bwa_wrapper_out1.sai test-data/bwa_wrapper_in1.fastqsanger > bwa_wrapper_out1.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
188 phiX.fasta is the prefix for the reference files (phiX.fasta.amb, phiX.fasta.ann, phiX.fasta.bwt, ...)
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
189 remove the comment lines (beginning with '@') from the resulting sam file
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
190 plain old sort doesn't handle underscores like python:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
191 python -c "import sys; lines=file(sys.argv[1],'rb').readlines(); lines.sort(); file(sys.argv[2],'wb').write(''.join(lines))" bwa_wrapper_out1.u.sam bwa_wrapper_out1.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
192 -->
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
193 <param name="refGenomeSource" value="indexed" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
194 <param name="indices" value="phiX" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
195 <param name="sPaired" value="single" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
196 <param name="input1" value="bwa_wrapper_in1.fastqsanger" ftype="fastqsanger" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
197 <param name="source_select" value="pre_set" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
198 <param name="suppressHeader" value="true" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
199 <output name="output" file="bwa_wrapper_out1.sam" ftype="sam" sort="True" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
200 </test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
201 <test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
202 <!--
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
203 BWA commands:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
204 cp test-data/phiX.fasta phiX.fasta
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
205 bwa index -a is phiX.fasta
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
206 bwa aln -n 0.04 -o 1 -e -1 -d 16 -i 5 -k 2 -t 4 -M 3 -O 11 -E 4 -R -N phiX.fasta test-data/bwa_wrapper_in1.fastqsanger > bwa_wrapper_out2.sai
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
207 bwa samse -n 3 phiX.fasta bwa_wrapper_out2.sai test-data/bwa_wrapper_in1.fastqsanger > bwa_wrapper_out2.u.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
208 phiX.fasta is the prefix for the reference files (phiX.fasta.amb, phiX.fasta.ann, phiX.fasta.bwt, ...)
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
209 remove the comment lines (beginning with '@') from the resulting sam file
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
210 plain old sort doesn't handle underscores like python:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
211 python -c "import sys; lines=file(sys.argv[1],'rb').readlines(); lines.sort(); file(sys.argv[2],'wb').write(''.join(lines))" bwa_wrapper_out2.u.sam bwa_wrapper_out2.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
212 -->
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
213 <param name="refGenomeSource" value="history" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
214 <param name="ownFile" value="phiX.fasta" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
215 <param name="sPaired" value="single" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
216 <param name="input1" value="bwa_wrapper_in1.fastqsanger" ftype="fastqsanger" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
217 <param name="source_select" value="full" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
218 <param name="maxEditDist" value="0" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
219 <param name="fracMissingAligns" value="0.04" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
220 <param name="maxGapOpens" value="1" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
221 <param name="maxGapExtens" value="-1" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
222 <param name="disallowLongDel" value="16" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
223 <param name="disallowIndel" value="5" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
224 <param name="seed" value="-1" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
225 <param name="maxEditDistSeed" value="2" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
226 <param name="mismatchPenalty" value="3" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
227 <param name="gapOpenPenalty" value="11" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
228 <param name="gapExtensPenalty" value="4" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
229 <param name="suboptAlign" value="" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
230 <param name="noIterSearch" value="true" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
231 <param name="outputTopN" value="3" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
232 <param name="outputTopNDisc" value="10" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
233 <param name="maxInsertSize" value="500" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
234 <param name="maxOccurPairing" value="100000" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
235 <param name="specReadGroup" value="no" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
236 <param name="suppressHeader" value="true" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
237 <output name="output" file="bwa_wrapper_out2.sam" ftype="sam" sort="True" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
238 </test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
239 <test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
240 <!--
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
241 BWA commands:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
242 bwa aln -n 0.04 -o 1 -e -1 -d 16 -i 5 -k 2 -t 4 -M 3 -O 11 -E 4 -R -N phiX.fasta test-data/bwa_wrapper_in2.fastqsanger > bwa_wrapper_out3a.sai
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
243 bwa aln -n 0.04 -o 1 -e -1 -d 16 -i 5 -k 2 -t 4 -M 3 -O 11 -E 4 -R -N phiX.fasta test-data/bwa_wrapper_in3.fastqsanger > bwa_wrapper_out3b.sai
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
244 bwa sampe -a 500 -o 100000 -n 3 -N 10 -r "@RG\tID:abcdefg\tDS:descrip\tDT:2010-11-01\tLB:lib-mom-A\tPI:400\tPL:ILLUMINA\tSM:mom" phiX.fasta bwa_wrapper_out3a.sai bwa_wrapper_out3b.sai test-data/bwa_wrapper_in2.fastqsanger test-data/bwa_wrapper_in3.fastqsanger > bwa_wrapper_out3.u.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
245 phiX.fasta is the prefix for the reference
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
246 plain old sort doesn't handle underscores like python:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
247 python -c "import sys; lines=file(sys.argv[1],'rb').readlines(); lines.sort(); file(sys.argv[2],'wb').write(''.join(lines))" bwa_wrapper_out3.u.sam bwa_wrapper_out3.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
248 -->
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
249 <param name="refGenomeSource" value="indexed" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
250 <param name="indices" value="phiX" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
251 <param name="sPaired" value="paired" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
252 <param name="input1" value="bwa_wrapper_in2.fastqsanger" ftype="fastqsanger" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
253 <param name="input2" value="bwa_wrapper_in3.fastqsanger" ftype="fastqsanger" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
254 <param name="source_select" value="full" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
255 <param name="maxEditDist" value="0" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
256 <param name="fracMissingAligns" value="0.04" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
257 <param name="maxGapOpens" value="1" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
258 <param name="maxGapExtens" value="-1" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
259 <param name="disallowLongDel" value="16" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
260 <param name="disallowIndel" value="5" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
261 <param name="seed" value="-1" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
262 <param name="maxEditDistSeed" value="2" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
263 <param name="mismatchPenalty" value="3" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
264 <param name="gapOpenPenalty" value="11" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
265 <param name="gapExtensPenalty" value="4" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
266 <param name="suboptAlign" value="" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
267 <param name="noIterSearch" value="true" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
268 <param name="outputTopN" value="3" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
269 <param name="outputTopNDisc" value="10" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
270 <param name="maxInsertSize" value="500" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
271 <param name="maxOccurPairing" value="100000" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
272 <param name="specReadGroup" value="yes" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
273 <param name="rgid" value="abcdefg" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
274 <param name="rgcn" value="" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
275 <param name="rgds" value="descrip" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
276 <param name="rgdt" value="2010-11-01" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
277 <param name="rgfo" value="" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
278 <param name="rgks" value="" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
279 <param name="rglb" value="lib-mom-A" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
280 <param name="rgpg" value="" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
281 <param name="rgpi" value="400" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
282 <param name="rgpl" value="ILLUMINA" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
283 <param name="rgpu" value="" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
284 <param name="rgsm" value="mom" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
285 <param name="suppressHeader" value="false" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
286 <output name="output" file="bwa_wrapper_out3.sam" ftype="sam" sort="True" lines_diff="2" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
287 </test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
288 <test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
289 <!--
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
290 BWA commands:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
291 cp test-data/phiX.fasta phiX.fasta
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
292 bwa index -a is phiX.fasta
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
293 bwa aln -t 4 phiX.fasta test-data/bwa_wrapper_in2.fastqsanger > bwa_wrapper_out8a.sai
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
294 bwa aln -t 4 phiX.fasta test-data/bwa_wrapper_in3.fastqsanger > bwa_wrapper_out8b.sai
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
295 bwa sampe -a 500 -o 100000 phiX.fasta bwa_wrapper_out8a.sai bwa_wrapper_out8b.sai test-data/bwa_wrapper_in2.fastqsanger test-data/bwa_wrapper_in3.fastqsanger > bwa_wrapper_out8.u.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
296 phiX.fa is the prefix for the reference
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
297 remove the comment lines (beginning with '@') from the resulting sam file
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
298 python -c "import sys; lines=file(sys.argv[1],'rb').readlines(); lines.sort(); file(sys.argv[2],'wb').write(''.join(lines))" bwa_wrapper_out8.u.sam bwa_wrapper_out8.sam
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
299 -->
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
300 <param name="refGenomeSource" value="history" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
301 <!-- this is the backwards-compatible "unique value" for this index, not an actual path -->
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
302 <param name="ownFile" value="phiX.fasta" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
303 <param name="sPaired" value="paired" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
304 <param name="input1" value="bwa_wrapper_in2.fastqsanger" ftype="fastqsanger" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
305 <param name="input2" value="bwa_wrapper_in3.fastqsanger" ftype="fastqsanger" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
306 <param name="source_select" value="preSet" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
307 <param name="suppressHeader" value="true" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
308 <output name="output" file="bwa_wrapper_out8.sam" ftype="sam" sort="True" />
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
309 </test>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
310 </tests>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
311 <help>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
312
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
313 **What it does**
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
314
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
315 BWA is a fast light-weighted tool that aligns relatively short sequences (queries) to a sequence database (large), such as the human reference genome. It is developed by Heng Li at the Sanger Insitute. Li H. and Durbin R. (2009) Fast and accurate short read alignment with Burrows-Wheeler transform. Bioinformatics, 25, 1754-60.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
316
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
317 ------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
318
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
319 **Know what you are doing**
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
320
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
321 .. class:: warningmark
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
322
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
323 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.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
324
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
325 .. __: http://bio-bwa.sourceforge.net/
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
326
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
327 ------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
328
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
329 **Input formats**
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
330
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
331 BWA accepts files in either Sanger FASTQ format (galaxy type *fastqsanger*) or Illumina FASTQ format (galaxy type *fastqillumina*). Use the FASTQ Groomer to prepare your files.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
332
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
333 ------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
334
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
335 **A Note on Built-in Reference Genomes**
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
336
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
337 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.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
338
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
339 ------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
340
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
341 **Outputs**
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
342
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
343 The output is in SAM format, and has the following columns::
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
344
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
345 Column Description
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
346 -------- --------------------------------------------------------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
347 1 QNAME Query (pair) NAME
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
348 2 FLAG bitwise FLAG
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
349 3 RNAME Reference sequence NAME
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
350 4 POS 1-based leftmost POSition/coordinate of clipped sequence
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
351 5 MAPQ MAPping Quality (Phred-scaled)
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
352 6 CIGAR extended CIGAR string
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
353 7 MRNM Mate Reference sequence NaMe ('=' if same as RNAME)
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
354 8 MPOS 1-based Mate POSition
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
355 9 ISIZE Inferred insert SIZE
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
356 10 SEQ query SEQuence on the same strand as the reference
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
357 11 QUAL query QUALity (ASCII-33 gives the Phred base quality)
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
358 12 OPT variable OPTional fields in the format TAG:VTYPE:VALU
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
359
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
360 The flags are as follows::
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
361
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
362 Flag Description
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
363 ------ -------------------------------------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
364 0x0001 the read is paired in sequencing
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
365 0x0002 the read is mapped in a proper pair
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
366 0x0004 the query sequence itself is unmapped
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
367 0x0008 the mate is unmapped
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
368 0x0010 strand of the query (1 for reverse)
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
369 0x0020 strand of the mate
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
370 0x0040 the read is the first read in a pair
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
371 0x0080 the read is the second read in a pair
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
372 0x0100 the alignment is not primary
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
373
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
374 It looks like this (scroll sideways to see the entire example)::
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
375
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
376 QNAME FLAG RNAME POS MAPQ CIAGR MRNM MPOS ISIZE SEQ QUAL OPT
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
377 HWI-EAS91_1_30788AAXX:1:1:1761:343 4 * 0 0 * * 0 0 AAAAAAANNAAAAAAAAAAAAAAAAAAAAAAAAAAACNNANNGAGTNGNNNNNNNGCTTCCCACAGNNCTGG hhhhhhh;;hhhhhhhhhhh^hOhhhhghhhfhhhgh;;h;;hhhh;h;;;;;;;hhhhhhghhhh;;Phhh
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
378 HWI-EAS91_1_30788AAXX:1:1:1578:331 4 * 0 0 * * 0 0 GTATAGANNAATAAGAAAAAAAAAAATGAAGACTTTCNNANNTCTGNANNNNNNNTCTTTTTTCAGNNGTAG hhhhhhh;;hhhhhhhhhhhhhhhhhhhhhhhhhhhh;;h;;hhhh;h;;;;;;;hhhhhhhhhhh;;hhVh
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
379
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
380 -------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
381
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
382 **BWA settings**
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
383
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
384 All of the options have a default value. You can change any of them. All of the options in BWA have been implemented here.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
385
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
386 ------
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
387
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
388 **BWA parameter list**
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
389
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
390 This is an exhaustive list of BWA options:
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
391
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
392 For **aln**::
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
393
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
394 -n NUM Maximum edit distance if the value is INT, or the fraction of missing
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
395 alignments given 2% uniform base error rate if FLOAT. In the latter
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
396 case, the maximum edit distance is automatically chosen for different
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
397 read lengths. [0.04]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
398 -o INT Maximum number of gap opens [1]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
399 -e INT Maximum number of gap extensions, -1 for k-difference mode
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
400 (disallowing long gaps) [-1]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
401 -d INT Disallow a long deletion within INT bp towards the 3'-end [16]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
402 -i INT Disallow an indel within INT bp towards the ends [5]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
403 -l INT Take the first INT subsequence as seed. If INT is larger than the
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
404 query sequence, seeding will be disabled. For long reads, this option
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
405 is typically ranged from 25 to 35 for '-k 2'. [inf]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
406 -k INT Maximum edit distance in the seed [2]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
407 -t INT Number of threads (multi-threading mode) [1]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
408 -M INT Mismatch penalty. BWA will not search for suboptimal hits with a score
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
409 lower than (bestScore-misMsc). [3]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
410 -O INT Gap open penalty [11]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
411 -E INT Gap extension penalty [4]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
412 -c Reverse query but not complement it, which is required for alignment
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
413 in the color space.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
414 -R Proceed with suboptimal alignments even if the top hit is a repeat. By
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
415 default, BWA only searches for suboptimal alignments if the top hit is
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
416 unique. Using this option has no effect on accuracy for single-end
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
417 reads. It is mainly designed for improving the alignment accuracy of
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
418 paired-end reads. However, the pairing procedure will be slowed down,
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
419 especially for very short reads (~32bp).
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
420 -N Disable iterative search. All hits with no more than maxDiff
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
421 differences will be found. This mode is much slower than the default.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
422
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
423 For **samse**::
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
424
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
425 -n INT Maximum number of alignments to output in the XA tag for reads paired
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
426 properly. If a read has more than INT hits, the XA tag will not be
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
427 written. [3]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
428 -r STR Specify the read group in a format like '@RG\tID:foo\tSM:bar' [null]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
429
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
430 For **sampe**::
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
431
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
432 -a INT Maximum insert size for a read pair to be considered as being mapped
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
433 properly. Since version 0.4.5, this option is only used when there
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
434 are not enough good alignment to infer the distribution of insert
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
435 sizes. [500]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
436 -n INT Maximum number of alignments to output in the XA tag for reads paired
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
437 properly. If a read has more than INT hits, the XA tag will not be
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
438 written. [3]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
439 -N INT Maximum number of alignments to output in the XA tag for disconcordant
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
440 read pairs (excluding singletons). If a read has more than INT hits,
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
441 the XA tag will not be written. [10]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
442 -o INT Maximum occurrences of a read for pairing. A read with more
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
443 occurrences will be treated as a single-end read. Reducing this
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
444 parameter helps faster pairing. [100000]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
445 -r STR Specify the read group in a format like '@RG\tID:foo\tSM:bar' [null]
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
446
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
447 For specifying the read group in **samse** or **sampe**, use the following::
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
448
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
449 @RG Read group. Unordered multiple @RG lines are allowed.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
450 ID Read group identifier. Each @RG line must have a unique ID. The value of
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
451 ID is used in the RG tags of alignment records. Must be unique among all
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
452 read groups in header section. Read group IDs may be modified when
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
453 merging SAM files in order to handle collisions.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
454 CN Name of sequencing center producing the read.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
455 DS Description.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
456 DT Date the run was produced (ISO8601 date or date/time).
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
457 FO Flow order. The array of nucleotide bases that correspond to the
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
458 nucleotides used for each flow of each read. Multi-base flows are encoded
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
459 in IUPAC format, and non-nucleotide flows by various other characters.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
460 Format : /\*|[ACMGRSVTWYHKDBN]+/
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
461 KS The array of nucleotide bases that correspond to the key sequence of each read.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
462 LB Library.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
463 PG Programs used for processing the read group.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
464 PI Predicted median insert size.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
465 PL Platform/technology used to produce the reads. Valid values : CAPILLARY,
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
466 LS454, ILLUMINA, SOLID, HELICOS, IONTORRENT and PACBIO.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
467 PU Platform unit (e.g. flowcell-barcode.lane for Illumina or slide for
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
468 SOLiD). Unique identifier.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
469 SM Sample. Use pool name where a pool is being sequenced.
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
470
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
471 </help>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
472 </tool>
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
473
ffa8aaa14f7c Uploaded initial tarball.
devteam
parents:
diff changeset
474