annotate bismark_bowtie2_wrapper.xml @ 3:7eefe5d6eecd draft

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