annotate bwa_color_wrapper.xml @ 0:8d92246f41bb draft

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