annotate fastq-mcf.xml @ 0:217aedbdd0d0

Uploaded
author jjohnson
date Tue, 13 Mar 2012 14:44:46 -0400
parents
children b61f1466ce8f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
1 <tool id="fastq_mcf" name="FastqMcf" version="1.0">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
2 <description>sequence quality filtering and clipping</description>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
3 <requirements>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
4 <requirement type="binary">fastq-mcf</requirement>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
5 </requirements>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
6 <version_string>fastq-mcf -V</version_string>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
7 <command>fastq-mcf
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
8 #if $trimming.choice == 'disable':
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
9 -0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
10 #elif $trimming.choice == 'user_set':
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
11 #if len($trimming.scale.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
12 -s $trimming.scale
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
13 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
14 #if len($trimming.minpct.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
15 -t $trimming.minpct
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
16 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
17 #if len($trimming.nmin.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
18 -m $trimming.nmin
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
19 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
20 #if len($trimming.pctdiff.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
21 -p $trimming.pctdiff
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
22 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
23 #if len($trimming.nmax.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
24 -L $trimming.nmax
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
25 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
26 #if len($trimming.nkeep.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
27 -l $trimming.nkeep
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
28 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
29 #if len($trimming.skewpct.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
30 -k $trimming.skewpct
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
31 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
32 #if len($trimming.qthr.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
33 -q $trimming.qthr
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
34 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
35 #if len($trimming.qwin.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
36 -w $trimming.qwin
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
37 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
38 #if len($trimming.pctns.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
39 -x $trimming.pctns
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
40 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
41 #if len($trimming.sampcnt.__str__) > 0
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
42 -s $trimming.sampcnt
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
43 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
44 $trimming.ilv3
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
45 $trimming.rmns
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
46 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
47 #if $noclip == True :
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
48 $noclip
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
49 #else :
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
50 -o $reads_out
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
51 #if $mates.__str__ != 'None' :
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
52 -o $mates_out
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
53 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
54 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
55 $adpaters
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
56 $reads
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
57 #if $mates.__str__ != 'None' :
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
58 $mates
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
59 #end if
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
60 > $log
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
61 </command>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
62 <inputs>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
63 <param name="adpaters" type="data" format="fasta" label="A fasta formatted adapter list" />
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
64 <param name="reads" type="data" format="fastqsanger,fastqillumina" label="Reads: single or Left-hand of Paired End Reads" />
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
65 <param name="mates" type="data" format="fastqsanger,fastqillumina" optional="true" label="Right-hand mates for Paired End Reads" />
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
66 <!--
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
67 -s N.N Log scale for clip pct to threshold (2.5)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
68 -t N % occurance threshold before clipping (0.25)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
69 -m N Minimum clip length, overrides scaled auto (1)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
70 -p N Maximum adapter difference percentage (20)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
71 -l N Minimum remaining sequence length (15)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
72 -L N Maximum sequence length (none)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
73 -k N sKew percentage causing trimming (2)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
74 -q N quality threshold causing trimming (10)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
75 -f force output, even if not much will be done
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
76 -0 Set all trimming parameters to zero
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
77 -U|u Force disable/enable illumina PF filtering
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
78 -P N phred-scale (64)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
79 -x N 'N' (Bad read) percentage causing trimming (10)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
80 -R Don't remove N's from the fronts/ends of reads
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
81 -n Don't clip, just output what would be done
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
82 -C N Number of reads to use for subsampling (200000)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
83 -d Output lots of random debugging stuff
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
84 -->
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
85
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
86
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
87 <conditional name="trimming">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
88 <param name="choice" type="select" label="Trimming Options">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
89 <option value="defaults">Use Defaults</option>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
90 <option value="user_set">Set Values</option>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
91 <option value="disable">Set all trimming parameters to zero</option>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
92 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
93 <when value="defaults"/>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
94 <when value="disable"/>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
95 <when value="user_set">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
96 <param name="sampcnt" type="integer" optional="true" label="-C Number of reads to use for subsampling (100000)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
97 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
98 <param name="scale" type="float" optional="true" label="-s N.N Log scale for clip pct to threshold (2.5)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
99 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
100 <param name="minpct" type="float" optional="true" label="-t % occurance threshold before clipping (0.25)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
101 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
102 <param name="nmin" type="integer" optional="true" label="-m Minimum clip length, overrides scaled auto (1)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
103 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
104 <param name="pctdiff" type="integer" optional="true" label="-p Maximum adapter difference percentage (20)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
105 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
106
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
107 <param name="nmax" type="integer" optional="true" label="-L Maximum sequence length (none)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
108 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
109 <param name="nkeep" type="integer" optional="true" label="-l Minimum remaining sequence length (15)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
110 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
111 <param name="skewpct" type="float" optional="true" label="-k sKew percentage causing trimming (2)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
112 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
113 <param name="qthr" type="integer" optional="true" label="-q quality threshold causing trimming (7)"
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
114 help="remove end of-read with quality &lt; threshold">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
115 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
116 <param name="qwin" type="integer" optional="true" label="-w mean quality threshold causing trimming (1)"
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
117 help="remove end of read with mean quality &lt; threshold">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
118 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
119 <param name="pctns" type="float" optional="true" label="-x 'N' (Bad read) percentage causing trimming (10)">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
120 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
121 <param name="rmns" type="boolean" truevalue="-R" falsevalue="" checked="false" label="-R Don't remove N's from the fronts/ends of reads"/>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
122 <param name="ilv3" type="select" label="illumina PF filtering">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
123 <option value=" ">Default</option>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
124 <option value="-U">Disable illumina PF filtering</option>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
125 <option value="-u">Enable illumina PF filtering</option>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
126 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
127 </when>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
128 </conditional>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
129
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
130
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
131 <param name="phred" type="integer" optional="true" label="-P phred-scale (64)" help="Default is to determine automatically">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
132 </param>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
133
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
134 <param name="noclip" type="boolean" truevalue="-n" falsevalue="" checked="false" label="-n Don't clip, just output what would be done"/>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
135
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
136 </inputs>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
137 <outputs>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
138 <data name="log" format="txt" label="${tool.name} on ${on_string}: log"/>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
139 <data name="reads_out" format_source="reads" label="${tool.name} on ${on_string}: reads">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
140 <filter>noclip == False</filter>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
141 </data>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
142 <data name="mates_out" format_source="mates" label="${tool.name} on ${on_string}: mates">
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
143 <filter>(noclip == False and mates != None)</filter>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
144 </data>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
145 </outputs>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
146 <tests>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
147 </tests>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
148 <help>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
149 **What it does**
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
150
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
151 fastq-mcf_ attempts to:
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
152
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
153 Detect and remove sequencing adapters and primers
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
154 Detect limited skewing at the ends of reads and clip
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
155 Detect poor quality at the ends of reads and clip
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
156 Detect N's, and remove from ends
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
157 Remove reads with CASAVA 'Y' flag (purity filtering)
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
158 Discard sequences that are too short after all of the above
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
159 Keep multiple mate-reads in sync while doing all of the above
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
160
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
161 .. _fastq-mcf: http://code.google.com/p/ea-utils/wiki/FastqMcf
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
162 -----
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
163
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
164 **Input**
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
165
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
166 Fasta file of adapter sequences, for example::
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
167
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
168 > Genomic_DNA_oligonucleotide_sequences_Adapters_F
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
169 GATCGGAAGAGCTCGTATGCCGTCTTCTGCTTG
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
170 > Genomic_DNA_oligonucleotide_sequences_Adapters_R
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
171 ACACTCTTTCCCTACACGACGCTCTTCCGATCT
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
172 > Genomic_DNA_Sequencing_Primer
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
173 ACACTCTTTCCCTACACGACGCTCTTCCGATCT
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
174
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
175
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
176
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
177 Reads or Left-hand mates, for example::
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
178
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
179 @1539:931/1
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
180 ACTTCCCGCGCGTGAAGGCGCCGGCAAACGAGGCTCGGGAAGGGGCTCCCG
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
181 +1539:931/1
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
182 BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
183
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
184 Right-hand mates, for example::
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
185
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
186 @1539:931/2
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
187 CGCCATTCCGAATCGTAGTTGTCGGCGTCTTCCAGTGCGGCAAGGCATCGT
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
188 +1539:931/2
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
189 WNUUZ\P^`BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
190
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
191 -----
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
192
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
193 **Output**
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
194
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
195 A log file
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
196
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
197 A trimmed fastq of the reads
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
198
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
199 A trimmed fastq of the mates
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
200
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
201
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
202
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
203 </help>
217aedbdd0d0 Uploaded
jjohnson
parents:
diff changeset
204 </tool>