annotate tools/sr_mapping/PerM.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="PerM" name="Map with PerM" version="1.1.2">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>for SOLiD and Illumina</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <!-- works with PerM version 0.2.6 -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <requirement type="package">perm</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 echo -n "PerM "; PerM 2>&amp;1 | grep "Version";
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 PerM
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 #if $s.sourceOfRef.refSource == "history"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 $s.sourceOfRef.ref
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 #else
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 #if $s.space == "color"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 "${ filter( lambda x: str( x[0] ) == str( $s.sourceOfRef.index ), $__app__.tool_data_tables[ 'perm_color_indexes' ].get_fields() )[0][-1] }"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 #elif $s.space == "base"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 "${ filter( lambda x: str( x[0] ) == str( $s.sourceOfRef.index ), $__app__.tool_data_tables[ 'perm_base_indexes' ].get_fields() )[0][-1] }"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 #if $s.mate.singleOrPairs == "single":
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 $s.mate.reads
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 #else:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 -1 $s.mate.reads1 -2 $s.mate.reads2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 -U $s.mate.upperbound
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 -L $s.mate.lowerbound
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 $s.mate.excludeAmbiguousPairs
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 #if $s.space == "color":
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 --readFormat "csfastq"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 #else:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 --readFormat "fastq"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 #if $int($str($valAlign)) &gt;= 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 -v $valAlign
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 #if $align.options == "full":
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 --seed $align.seed
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 -$align.alignments
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 #if $str($align.delimiter) != "None"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 --delimiter $align.delimiter
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 -T $align.sTrimL
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 $align.includeReadsWN
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 $align.statsOnly
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 $align.ignoreQS
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 #if $str($bUnmappedRead) == "true" and $s.space == "color"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 -u $unmappedReadOutCS
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 #elif $str($bUnmappedRead) == "true" and $s.space == "base"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 -u $unmappedReadOut
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 -o $output
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 --outputFormat sam
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 --noSamHeader | tr '\r' '\n' | tr -cd "[:print:]\t\n " | grep "Reads\|Sub0\|Pairs\|single" | sed 's/.*Reads:,//' | sed 's/\/.*dat,_ Sub0/Sub0/'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 <conditional name="s">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 <param name="space" label="Is your data color space (SOLiD) or base space (Illumina)?" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 <option value="color">Color space</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <option value="base">Base space</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 <when value="color">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 <conditional name="sourceOfRef">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 <param name="refSource" label="Will you provide your own reference file from the history or use a built-in index?" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 <option value="indexed">Built-in index</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 <option value="history">Fasta file from history</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 <when value="indexed">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 <param name="index" type="select" label="Select a reference genome (with seed and read length)" help="if your genome of interest is not listed - contact Galaxy team">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 <options from_data_table="perm_color_indexes"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 <when value="history">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 <param name="ref" format="fasta" type="data" label="Reference" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 <conditional name="mate">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 <param name="singleOrPairs" label="Mate-paired?" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 <option value="single">Single-end</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 <option value="paired">Mate pairs</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 <when value="single">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 <param format="fastqcssanger" name="reads" type="data" label="Reads" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 <when value="paired">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 <param name="reads1" format="fastqcssanger" label="Forward FASTQ file" type="data" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 <param name="reads2" format="fastqcssanger" label="Reverse FASTQ file" type="data" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 <param label="Upperbound of pairs separation (-U)" name="upperbound" type="integer" size="8" value="100000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 <param label="Lowerbound of pairs separation (-L)" name="lowerbound" type="integer" size="8" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 <param label="Exclude ambiguous pairs (-e)" name="excludeAmbiguousPairs" type="boolean" checked="false" truevalue="-e" falsevalue="" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 <when value="base">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 <conditional name="sourceOfRef">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 <param name="refSource" label="Will you provide your own reference file from the history or use a built-in index?" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 <option value="indexed">Built-in index</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 <option value="history">Fasta file from history</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 <when value="indexed">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 <param name="index" type="select" label="Select a reference genome with seed and read length" help="if your genome of interest is not listed - contact Galaxy team">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 <options from_data_table="perm_base_indexes"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 <when value="history">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105 <param name="ref" format="fasta" type="data" label="Reference" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108 <conditional name="mate">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109 <param name="singleOrPairs" label="Mate-paired?" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110 <option value="single">Single-end</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111 <option value="paired">Mate pairs</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
113 <when value="single">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
114 <param format="fastqsanger" name="reads" type="data" label="Reads" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
115 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
116 <when value="paired">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
117 <param name="reads1" format="fastqsanger" label="Forward FASTQ file" type="data" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
118 <param name="reads2" format="fastqsanger" label="Reverse FASTQ file" type="data" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
119 <param label="Upperbound of pairs separation (-U)" name="upperbound" type="integer" size="8" value="100000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
120 <param label="Lowerbound of pairs separation (-L)" name="lowerbound" type="integer" size="8" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
121 <param label="Exclude ambiguous pairs (-e)" name="excludeAmbiguousPairs" type="boolean" checked="false" truevalue="-e" falsevalue="" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
122 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
123 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
124 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
125 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
126 <param label="Maximum number of mismatches permitted in one end of full read (-v)" name="valAlign" type="integer" size="5" value="2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
127 <conditional name="align">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
128 <param help="Use default setting or specify full parameters list" label="PerM settings to use" name="options" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
129 <option value="preSet">Commonly used</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
130 <option value="full">Full parameter list</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
131 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
132 <when value="preSet"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
133 <when value="full">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
134 <param label="Whether or not to report all valid alignments per read (-A/-B/-E)" name="alignments" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
135 <option value="A">Report all valid alignments</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
136 <option value="B">Report the best alignments in terms of number of mismatches</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
137 <option value="E">Report only uniquely mapped reads</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
138 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
139 <param label="Choose the seed full sensitive to different number of mismatches (--seed)" name="seed" type="select" >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
140 <option value="F2">2 mismatches</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
141 <option value="S11">1 SNP + 1 color error</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
142 <option value="F3">3 mismatches</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
143 <option value="F4">4 mismatches</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
144 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
145 <param label="Choose the delimiter to identify read name (--delimiter)" name="delimiter" type="select">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
146 <option value="None">Tab/Space/Comma</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
147 <option value=":">Colon</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
148 <option value="_">Underscore</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
149 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
150 <param label="Use the first n bases of each read for alignment (-T)" name="sTrimL" type="integer" size="5" value="50" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
151 <param name="includeReadsWN" type="boolean" checked="true" truevalue="--includeReadsWN" falsevalue="" label="Include reads with 'N' or '.' by encoding '.' as 3, 'N' as 'A' (--includeReadsWN)" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
152 <param name="statsOnly" type="boolean" checked="false" truevalue="--statsOnly" falsevalue="" label="Output mapping stats only. Don't output alignments (--statsOnly)" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
153 <param name="ignoreQS" type="boolean" checked="false" truevalue="--ignoreQS" falsevalue="" label="Ignore quality scores (--ignoreQS)" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
154 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
155 </conditional> <!-- options -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
156 <param name="bUnmappedRead" type="select" label="Output the unmapped reads (-u)">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
157 <option value="true">Yes</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
158 <option value="false">No</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
159 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
160 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
161 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
162 <data format="sam" name="output" label="${tool.name} on ${on_string}: mapped reads" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
163 <data format="fastqsanger" name="unmappedReadOut" label="${tool.name} on ${on_string}: unmapped reads">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
164 <filter>bUnmappedRead == "true" and s["space"] == "base"</filter>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
165 </data>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
166 <data format="fastqcssanger" name="unmappedReadOutCS" label="${tool.name} on ${on_string}: unmapped reads">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
167 <filter>bUnmappedRead == "true" and s["space"] == "color"</filter>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
168 </data>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
169 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
170 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
171 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
172 <!--
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
173 PerM command:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
174 PerM /afs/bx.psu.edu/depot/data/genome/phiX/perm_index/phiX_base_F3_50.index -1 test-data/perm_in1.fastqsanger -2 test-data/perm_in2.fastqsanger -U 100000 -L 0 -e +readFormat fastq -v 0 +seed F3 -A -T 50 +includeReadsWN -o perm_out1.sam +outputFormat sam +noSamHeader | tr '\r' '\n' | tr -cd "[:print:]\t\n " | grep "Reads\|Sub0\|Pairs\|single" | sed 's/.*Reads:,//' | sed 's/\/.*dat,_ Sub0/Sub0/'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
175 You need to replace the + with 2 dashes.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
176 -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
177 <param name="space" value="base" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
178 <param name="refSource" value="indexed" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
179 <param name="index" value="phiX_F3_50" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
180 <param name="singleOrPairs" value="paired" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
181 <param name="reads1" value="perm_in1.fastqsanger" ftype="fastqsanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
182 <param name="reads2" value="perm_in2.fastqsanger" ftype="fastqsanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
183 <param name="upperbound" value="100000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
184 <param name="lowerbound" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
185 <param name="excludeAmbiguousPairs" value="true" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
186 <param name="valAlign" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
187 <param name="options" value="full" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
188 <param name="alignments" value="A" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
189 <param name="seed" value="F3" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
190 <param name="delimiter" value="None" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
191 <param name="sTrimL" value="50" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
192 <param name="includeReadsWN" value="true" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
193 <param name="statsOnly" value="false" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
194 <param name="ignoreQS" value="false" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
195 <param name="bUnmappedRead" value="false" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
196 <output name="output" file="perm_out1.sam" ftype="sam" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
197 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
198 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
199 <!--
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
200 PerM command:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
201 PerM test-data/chr_m.fasta test-data/perm_in3.fastqsanger +readFormat fastq -v 2 -u perm_out3.fastqsanger -o perm_out2.sam +outputFormat sam +noSamHeader | tr '\r' '\n' | tr -cd "[:print:]\t\n " | grep "Reads\|Sub0\|Pairs\|single" | sed 's/.*Reads:,//' | sed 's/\/.*dat,_ Sub0/Sub0/'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
202 You need to replace the + with 2 dashes.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
203 -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
204 <param name="space" value="base" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
205 <param name="refSource" value="history" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
206 <param name="ref" value="chr_m.fasta" ftype="fasta" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
207 <param name="singleOrPairs" value="single" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
208 <param name="reads" value="perm_in3.fastqsanger" ftype="fastqsanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
209 <param name="valAlign" value="2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
210 <param name="options" value="preSet" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
211 <param name="bUnmappedRead" value="true" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
212 <output name="output" file="perm_out2.sam" ftype="sam" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
213 <output name="unmappedReadOut" file="perm_out3.fastqsanger" ftype="fastqsanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
214 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
215 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
216 <!--
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
217 PerM command:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
218 PerM test-data/phiX.fasta test-data/perm_in4.fastqcssanger +readFormat csfastq -v 1 -o perm_out4.sam +outputFormat sam +noSamHeader | tr '\r' '\n' | tr -cd "[:print:]\t\n " | grep "Reads\|Sub0\|Pairs\|single" | sed 's/.*Reads:,//' | sed 's/\/.*dat,_ Sub0/Sub0/'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
219 You need to replace the + with 2 dashes.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
220 -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
221 <param name="space" value="color" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
222 <param name="refSource" value="history" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
223 <param name="ref" value="phiX.fasta" ftype="fasta" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
224 <param name="singleOrPairs" value="single" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
225 <param name="reads" value="perm_in4.fastqcssanger" ftype="fastqcssanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
226 <param name="valAlign" value="1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
227 <param name="options" value="preSet" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
228 <param name="bUnmappedRead" value="false" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
229 <output name="output" file="perm_out4.sam" ftype="sam" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
230 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
231 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
232 <!--
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
233 PerM command:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
234 PerM /afs/bx.psu.edu/depot/data/genome/equCab2/perm_index/equCab2_chrM_color_F2_50.index -1 test-data/perm_in5.fastqcssanger -2 test-data/perm_in6.fastqcssanger -U 90000 -L 10000 +readFormat csfastq -v 3 +seed F2-o perm_out5.sam +outputFormat sam +noSamHeader | tr '\r' '\n' | tr -cd "[:print:]\t\n " | grep "Reads\|Sub0\|Pairs\|single" | sed 's/.*Reads:,//' | sed 's/\/.*dat,_ Sub0/Sub0/'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
235 You need to replace the + with 2 dashes.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
236 -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
237 <param name="space" value="color" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
238 <param name="refSource" value="indexed" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
239 <param name="index" value="equCab2_chrM_F2_50" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
240 <param name="singleOrPairs" value="paired" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
241 <param name="reads1" value="perm_in5.fastqcssanger" ftype="fastqcssanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
242 <param name="reads2" value="perm_in6.fastqcssanger" ftype="fastqcssanger" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
243 <param name="upperbound" value="90000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
244 <param name="lowerbound" value="10000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
245 <param name="excludeAmbiguousPairs" value="false" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
246 <param name="valAlign" value="3" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
247 <param name="options" value="preSet" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
248 <param name="bUnmappedRead" value="false" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
249 <output name="output" file="perm_out5.sam" ftype="sam" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
250 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
251 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
252 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
253 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
254
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
255 PerM is a short read aligner designed to be ultrafast with long SOLiD reads to the whole genome or transcriptions. PerM can be fully sensitive to alignments with up to four mismatches and highly sensitive to a higher number of mismatches.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
256
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
257 **Development team**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
258
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
259 PerM is developed by Ting Chen's group, Center of Excellence in Genomic Sciences at the University of Southern California. If you have any questions, please email yanghoch at usc.edu or check the `project page`__.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
260
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
261 .. __: http://code.google.com/p/perm/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
262
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
263 **Citation**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
264
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
265 PerM: Efficient mapping of short sequencing reads with periodic full sensitive spaced seeds. Bioinformatics, 2009, 25 (19): 2514-2521.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
266
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
267 **Input**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
268
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
269 The input files are read files and a reference. Users can use the pre-indexed reference in Galaxy or upload their own reference.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
270
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
271 The uploaded reference file should be in the fasta format. Multiple sequences like transcriptions should be concatenated together separated by a header line that starts with the ">" character.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
272
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
273 Reads files must be in either fastqsanger or fastqcssanger format to use in PerM. However, there are several possible starting formats that can be converted to one of those two: fastq (any type), color-space fastq, fasta, csfasta, or csfasta+qualsolid.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
274
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
275 An uploaded base-space fastq file MUST be checked/transformed with FASTQGroomer tools in Galaxy to be converted to the fastqsanger format (this is true even if the original file is in Sanger format).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
276
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
277 Uploaded fasta and csfasta without quality score files can be transformed to fastqsanger by the FASTQGroomer, with pseudo quality scores added.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
278
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
279 An uploaded csfasta + qual pair can also be transformed into fastqcssanger by solid2fastq.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
280
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
281 **Outputs**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
282
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
283 The output mapping result is in SAM format, and has the following columns::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
284
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
285 Column Description
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
286 -------- --------------------------------------------------------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
287 1 QNAME Query (pair) NAME
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
288 2 FLAG bitwise FLAG
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
289 3 RNAME Reference sequence NAME
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
290 4 POS 1-based leftmost POSition/coordinate of clipped sequence
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
291 5 MAPQ MAPping Quality (Phred-scaled)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
292 6 CIGAR extended CIGAR string
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
293 7 MRNM Mate Reference sequence NaMe ('=' if same as RNAME)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
294 8 MPOS 1-based Mate POSition
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
295 9 ISIZE Inferred insert SIZE
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
296 10 SEQ query SEQuence on the same strand as the reference
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
297 11 QUAL query QUALity (ASCII-33 gives the Phred base quality)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
298 12 OPT variable OPTional fields in the format TAG:VTYPE:VALUE
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
299 12.1 NM Number of mismatches (SOLiD-specific)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
300 12.2 CS Reads in color space (SOLiD-specific)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
301 12.3 CQ Bases quality in color spacehidden="true" (SOLiD-specific)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
302
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
303 The flags are as follows::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
304
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
305 Flag Description
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
306 ------ -------------------------------------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
307 0x0001 the read is paired in sequencing
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
308 0x0002 the read is mapped in a proper pair
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
309 0x0004 the query sequence itself is unmapped
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
310 0x0008 the mate is unmapped
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
311 0x0010 strand of the query (1 for reverse)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
312 0x0020 strand of the mate
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
313 0x0040 the read is the first read in a pair
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
314 0x0080 the read is the second read in a pair
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
315 0x0100 the alignment is not primary
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
316
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
317 Here is some sample output::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
318
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
319 Qname FLAG Rname POS MAPQ CIAGR MRNM MPOS ISIZE SEQ QUAL NM CS CQ
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
320 491_28_332_F3 16 ref-1 282734 255 35M * 0 0 AGTCAAACTCCGAATGCCAATGACTTATCCTTAGG #%%%%%%%!!%%%!!%%%%%%%%!!%%%%%%%%%% NM:i:3 CS:Z:C0230202330012130103100230121001212 CQ:Z:###################################
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
321 491_28_332_F3 16 ref-1 269436 255 35M * 0 0 AGTCAAACTCCGAATGCCAATGACTTATCCTTAGG #%%%%%%%!!%%%!!%%%%%%%%!!%%%%%%%%%% NM:i:3 CS:Z:C0230202330012130103100230121001212 CQ:Z:###################################
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
322
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
323 The user can check a checkbox for optional output containing the unmmaped reads in fastqsanger or fastqcssanger. The default is to produce it.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
324
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
325 **PerM parameter list**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
326
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
327 Below is a list of PerM command line options for PerM. Not all of these are relevant to Galaxy's implementation, but are included for completeness.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
328
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
329 The command for single-end::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
330
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
331 PerM [ref_or_index] [read] [options]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
332
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
333 The command for paired-end::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
334
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
335 PerM [ref_or_index] -1 [read1] -2 [read1] [options]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
336
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
337 The command-line options::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
338
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
339 -A Output all alignments within the given mismatch threshold, end-to-end.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
340 -B Output best alignments in terms of mismatches in the given mismatch threshold. [Default]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
341 -E Output only the uniquely mapped reads in the given mismatch threshold.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
342 -m Create the reference index, without reusing the saved index.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
343 -s PATH Save the reference index to accelerate the mapping in the future. If PATH is not specified, the default path will be used.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
344 -v INT Where INT is the number of mismatches allowed in one end. [Default=2]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
345 -T INT Where INT is the length to truncate read length to, so 30 means use only first 30 bases (signals). Leave blank if the full read is meant to be used.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
346 -o PATH Where PATH is for output the mapping of one read set. PerM's output are in .mapping or .sam format, determined by the ext name of PATH. Ex: -o out.sam will output in SAM format; -o out.mapping will output in .mapping format.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
347 -d PATH Where PATH is the directory for multiple read sets.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
348 -u PATH Print the fastq file of those unmapped reads to the file in PATH.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
349 --noSamHeader Print no SAM header so it is convenient to concatenate multiple SAM output files.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
350 --includeReadsWN Encodes N or "." with A or 3, respectively.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
351 --statsOnly Output the mapping statistics in stdout only, without saving alignments to files.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
352 --ignoreQS Ignore the quality scores in fastq or QUAL files.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
353 --seed {F2 | S11 | F3 | F4} Specify the seed pattern, which has a specific full sensitivity. Check the algorithm page (link below) for seed patterns to balance the sensitivity and running time.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
354 --readFormat {fasta | fastq | csfasta | csfastq} Read in reads in the specified format, instead of guessing according to the extension name.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
355 --delimiter CHAR Which is a character used as the delimiter to separate the the read id, and the additional info in the line with ">" in fasta or csfasta.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
356
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
357 Paired reads options::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
358
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
359 -e Exclude ambiguous paired.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
360 -L INT Mate-paired separate lower bound.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
361 -U INT Mate-paired separate upper bound.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
362 -1 PATH The forward reads file path.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
363 -2 PATH The reversed reads file path.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
364
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
365 See the PerM `algorithm page`__ for information on algorithms and seeds.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
366
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
367 .. __: http://code.google.com/p/perm/wiki/Algorithms
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
368 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
369 </tool>