annotate tools/sr_mapping/bwa_wrapper.xml @ 0:9071e359b9a3

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