annotate smalt/smalt_wrapper.xml @ 10:b75227b2833e draft default tip

Uploaded
author triasteran
date Tue, 08 Mar 2022 11:44:09 +0000
parents 81f36745bc9d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
1 <tool id="smalt_wrapper (docker)" name="SMALT" version="0.0.3">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
2 <requirements>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
3 <container type="docker">apetkau/smalt-galaxy</container>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
4 </requirements>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
5 <description>maps query reads onto the reference sequences</description>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
6 <command>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
7 smalt_wrapper.py
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
8 --threads="4"
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
9
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
10 ## reference source
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
11 --fileSource=$genomeSource.refGenomeSource
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
12 #if $genomeSource.refGenomeSource == "history":
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
13 ##build index on the fly
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
14 --ref="${genomeSource.ownFile}"
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
15 --dbkey=$dbkey
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
16 #else:
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
17 ##use precomputed indexes
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
18 --ref="${genomeSource.indices.fields.path}"
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
19 --do_not_build_index
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
20 #end if
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
21
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
22 ## input file(s)
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
23 --input1=$paired.input1
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
24 #if $paired.sPaired == "paired":
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
25 --input2=$paired.input2
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
26 #end if
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
27
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
28 ## output file
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
29 --output=$output
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
30
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
31 ## run parameters
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
32 --genAlignType=$paired.sPaired
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
33 --params=$params.source_select
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
34 #if $params.source_select != "pre_set":
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
35 --scorDiff=$params.scorDiff
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
36 #if $paired.sPaired == "paired":
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
37 --insertMax=$params.insertMax
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
38 --insertMin=$params.insertMin
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
39 --pairTyp=$params.pairTyp
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
40 #end if
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
41 --minScor=$params.minScor
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
42 --partialAlignments=$params.partialAlignments
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
43 --minBasq=$params.minBasq
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
44 --seed=$params.seed
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
45 --complexityWeighted=$params.complexityWeighted
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
46 --exhaustiveSearch=$params.cExhaustiveSearch.exhaustiveSearch
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
47 #if $params.cExhaustiveSearch.exhaustiveSearch == "true"
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
48 --minCover=$params.cExhaustiveSearch.minCover
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
49 #end if
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
50 --minId=$params.minId
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
51 #end if
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
52
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
53 ## suppress output SAM header
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
54 --suppressHeader=$suppressHeader
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
55 </command>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
56 <inputs>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
57 <conditional name="genomeSource">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
58 <param name="refGenomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
59 <option value="indexed">Use a built-in index</option>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
60 <option value="history">Use one from the history</option>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
61 </param>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
62 <when value="indexed">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
63 <param name="indices" type="select" label="Select a reference genome">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
64 <options from_data_table="smalt_indexes">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
65 <filter type="sort_by" column="2" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
66 <validator type="no_options" message="No indexes are available" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
67 </options>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
68 </param>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
69 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
70 <when value="history">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
71 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select a reference from history" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
72 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
73 </conditional>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
74 <conditional name="paired">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
75 <param name="sPaired" type="select" label="Is this library mate-paired?">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
76 <option value="single">Single-end</option>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
77 <option value="paired">Paired-end</option>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
78 </param>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
79 <when value="single">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
80 <param name="input1" type="data" format="fastqsanger" label="FASTQ file" help="FASTQ with Sanger-scaled quality values (fastqsanger)" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
81 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
82 <when value="paired">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
83 <param name="input1" type="data" format="fastqsanger" label="Forward FASTQ file" help="FASTQ with Sanger-scaled quality values (fastqsanger)" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
84 <param name="input2" type="data" format="fastqsanger" label="Reverse FASTQ file" help="FASTQ with Sanger-scaled quality values (fastqsanger)" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
85 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
86 </conditional>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
87 <conditional name="params">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
88 <param name="source_select" type="select" label="Smalt settings to use" help="For most mapping needs use Commonly Used settings. If you want full control use Full Parameter List">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
89 <option value="pre_set">Commonly Used</option>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
90 <option value="full">Full Parameter List</option>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
91 </param>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
92 <when value="pre_set" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
93 <when value="full">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
94 <conditional name="cExhaustiveSearch">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
95 <param name="exhaustiveSearch" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Do exhaustive search? (map -x)" help="This flag triggers a more exhaustive search for alignments at the cost of decreased speed." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
96 <when value="true">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
97 <param name="minCover" type="float" value="0" label="Minimum cover (map -c)" help="Only consider mappings where the k-mer word seeds cover the query read to a minimum extent." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
98 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
99 <when value="no" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
100 </conditional>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
101 <param name="scorDiff" type="integer" value="0" label="Score diff (map -d)" help="Set a threshold of the Smith-Waterman alignment score relative to the maximum score." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
102 <param name="insertMax" type="integer" value="500" label="Maximum insert size (map -i)" help="Only in paired-end mode." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
103 <param name="insertMin" type="integer" value="0" label="Minimum insert size (map -j)" help="Only in paired-end mode." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
104 <param name="pairTyp" type="text" size="2" value="pe" label="Type of read pair library (map -l)" help="Can be either 'pe', 'mp' or 'pp'." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
105 <param name="minScor" type="integer" value="0" label="Minimum score (map -m)" help="Sets an absolute threshold of the Smith-Waterman scores." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
106 <param name="partialAlignments" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Partial alignments (map -p)" help="Report partial alignments if they are complementary on the read (split reads)." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
107 <param name="minBasq" type="integer" value="0" label="Base quality threshold (map -q)" help="Sets a base quality threshold (0 &lt;= minbasq &lt;= 10, default 0)." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
108 <param name="seed" type="integer" value="0" label="Seed (map -r)" help="See below." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
109 <param name="complexityWeighted" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Complexity weighted (map -w)" help="Smith-Waterman scores are complexity weighted." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
110 <param name="minId" type="float" value="0" label="Identity threshold (map -y)" help="Sets an identity threshold for a mapping to be reported." />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
111 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
112 </conditional>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
113 <param name="suppressHeader" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Suppress the header in the output SAM file" help="Smalt produces SAM with several lines of header information" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
114 </inputs>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
115 <outputs>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
116 <data format="sam" name="output" label="${tool.name} on ${on_string}: mapped reads">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
117 <actions>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
118 <conditional name="genomeSource.refGenomeSource">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
119 <when value="indexed">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
120 <action type="metadata" name="dbkey">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
121 <option type="from_data_table" name="smalt_indexes" column="1">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
122 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
123 <filter type="param_value" ref="genomeSource.indices" column="0"/>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
124 </option>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
125 </action>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
126 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
127 <when value="history">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
128 <action type="metadata" name="dbkey">
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
129 <option type="from_param" name="genomeSource.ownFile" param_attribute="dbkey" />
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
130 </action>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
131 </when>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
132 </conditional>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
133 </actions>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
134 </data>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
135 </outputs>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
136 <help>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
137
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
138 **What it does**
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
139
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
140 SMALT is a pairwise sequence alignment program for the experimentingcient mapping of DNA sequencing reads onto genomic reference sequences. It uses a combination of short-word hashing and dynamic programming. Most types of sequencing platforms are supported including paired-end sequencing reads.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
141
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
142 ------
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
143
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
144 Please cite the website "http://www.sanger.ac.uk/resources/software/smalt/".
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
145
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
146 ------
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
147
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
148 **Know what you are doing**
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
149
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
150 .. class:: warningmark
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
151
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
152 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.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
153
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
154 .. __: http://www.sanger.ac.uk/resources/software/smalt/
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
155
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
156 ------
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
157
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
158 **Input formats**
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
159
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
160 SMALT accepts files in Sanger FASTQ format (galaxy type *fastqsanger*). Use the FASTQ Groomer to prepare your files.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
161
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
162 ------
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
163
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
164 **A Note on Built-in Reference Genomes**
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
165
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
166 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.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
167
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
168 ------
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
169
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
170 **Outputs**
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
171
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
172 The output is in SAM format.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
173
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
174 -------
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
175
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
176 **SMALT parameter list**
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
177
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
178 This is an exhaustive list of SMALT options:
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
179
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
180 For **map**::
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
181
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
182 -a
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
183 Output explicit alignments along with the mappings.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
184
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
185 -c &lt;mincover&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
186 Only consider mappings where the k-mer word seeds cover the query read to
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
187 a minimum extent. If &lt;mincover&gt; is an integer or floating point &gt; 1.0, at
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
188 least this many bases of the read must be covered by k-mer word seeds. If
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
189 &lt;mincover&gt; is a floating point &lt;= 1.0, it specifies the fraction of the
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
190 query read length that must be covered by k-mer word seeds. This option
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
191 is only valid in conjunction with the '-x' flag.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
192
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
193 -d &lt;scordiff&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
194 Set a threshold of the Smith-Waterman alignment score relative to the
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
195 maximum score. When mapping single reads, all alignments are reported
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
196 that have Smith-Waterman scores within &lt;scorediff&gt; of the maximum.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
197 Mappings with lower scores are skipped. If &lt;scorediff&gt; is set to to a
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
198 value &lt; 0, all alignments are printed that have scores above the
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
199 threshold specified with the '-m &lt;minscor&gt;' option.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
200 For paired reads, only a value of 0 is supported. With the option '-d 0'
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
201 all aligments (pairings) with the best score are output. By default
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
202 (without the option '-d 0') single reads/mates with multiple best mappings
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
203 are reported as 'not mapped'.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
204
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
205 -f &lt;format&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
206 Specifies the output format. &lt;format&gt; can be either 'bam', 'cigar', 'gff',
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
207 'sam' (default), 'samsoft' or 'ssaha'. Optional extension 'sam:nohead,clip'
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
208 (see manual)
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
209
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
210 -F &lt;inform&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
211 Specifies the input format. &lt;inform&gt; can be either 'fastq' (default),
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
212 'sam' or 'bam' (see: samtools.sourceforge.net). SAM and BAM formats
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
213 require additional libraries to be installed.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
214
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
215 -g &lt;insfil&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
216 Use the distribution of insert sizes stored in the file &lt;insfil&gt;. This
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
217 file is in ASCII format and can be generated using the 'sample' task see
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
218 'smalt sample -H' for help).
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
219
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
220 -H
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
221 Print these instructions.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
222
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
223 -i &lt;insertmax&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
224 Maximum insert size (only in paired-end mode). The default is 500.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
225
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
226 -j &lt;insertmin&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
227 Minimum insert size (only in paired-end mode). The default is 0.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
228
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
229 -l &lt;pairtyp&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
230 Type of read pair library. &lt;pairtyp&gt; can be either 'pe', i.e. for
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
231 the Illumina paired-end library for short inserts (|--&gt; &lt;--|). 'mp'
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
232 for the Illumina mate-pair library for long inserts (&lt;--| |--&gt;) or
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
233 'pp' for mates sequenced on the same strand (|--&gt; |--&gt;). 'pe' is the
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
234 default.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
235
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
236 -m &lt;minscor&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
237 Sets an absolute threshold of the Smith-Waterman scores. Mappings with
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
238 scores below that threshold will not be reported. The default is
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
239 &lt;minscor&gt; = &lt;wordlen&gt; + &lt;stepsiz&gt; - 1
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
240
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
241 -n &lt;nthreads&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
242 Run smalt using mutiple threads. &lt;nthread&gt; is the number of additional
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
243 threads forked from the main thread. The order of the reads in the
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
244 input files is not preserved for the output unless '-O' is also specified.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
245
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
246 -o &lt;oufilnam&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
247 Write mapping output (e.g. SAM lines) to a separate file. If this option
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
248 is not specified, mappings are written to standard output together with
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
249 other messages.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
250
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
251 -O
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
252 Output mappings in the order of the reads in the input files when using
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
253 multiple threads (option '-n &lt;nthreads&gt;').
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
254
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
255 -p
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
256 Report partial alignments if they are complementary on the read (split
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
257 reads).
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
258
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
259 -q &lt;minbasq&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
260 Sets a base quality threshold (0 &lt;= minbasq &lt;= 10, default 0).
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
261 K-mer words of the read with nucleotides that have a base quality below
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
262 this threshold are not looked up in the hash index.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
263
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
264 -r &lt;seed&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
265 If &lt;seed&gt; &gt;= 0 report an alignment selected at random where there are
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
266 multiple mappings with the same best alignment score. With &lt;seed&gt; = 0
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
267 (default) a seed is derived from the current calendar time. If &lt;seed&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
268 &lt; 0 reads with multiple best mappings are reported as 'not mapped'.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
269
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
270 -T &lt;tmp_dir&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
271 Write temporary files to directory &lt;tmp_dir&gt; (used with input files in
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
272 SAM/BAM format).
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
273
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
274 -w
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
275 Smith-Waterman scores are complexity weighted.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
276
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
277 -x
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
278 This flag triggers a more exhaustive search for alignments at the cost
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
279 of decreased speed. In paired-end mode each mate is mapped independently.
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
280 (By default the mate with fewer hits in the hash index is mapped first
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
281 and the vicinity is searched for mappings of its mate.)
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
282
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
283 -y &lt;minid&gt;
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
284 Sets an identity threshold for a mapping to be reported (default: 0).
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
285 &lt;minid&gt; specifies the number of exactly matching nucleotides either as
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
286 a positive integer or as a fraction of the read length (&lt;= 1.0).
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
287
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
288 </help>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
289 </tool>
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
290
81f36745bc9d Uploaded
triasteran
parents:
diff changeset
291