annotate fastq_quality_filter.xml @ 2:e41385662e5e draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
author devteam
date Wed, 11 Nov 2015 12:37:55 -0500
parents 57adb07cccfc
children 43a7370aa010
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="cshl_fastq_quality_filter" version="1.0.0" name="Filter by quality">
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
2 <description></description>
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
6 <command>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
7 <![CDATA[
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
8 zcat -f < '$input' | fastq_quality_filter -q $quality -p $percent -v -o '$output'
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
9 #if $input.ext == "fastqsanger":
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
10 -Q 33
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
11 #end if
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
12 ]]>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
13 </command>
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
14
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
15 <inputs>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
16 <param format="fastqsolexa,fastqsanger" name="input" type="data" label="Library to filter" />
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
17
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
18 <param name="quality" type="integer" value="20">
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
19 <label>Quality cut-off value</label>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
20 </param>
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
21
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
22 <param name="percent" type="integer" value="90">
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
23 <label>Percent of bases in sequence that must have quality equal to / higher than cut-off value</label>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
24 </param>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
25 </inputs>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
26 <outputs>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
27 <data format_source="input" name="output" metadata_source="input" />
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
28 </outputs>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
29 <tests>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
30 <test>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
31 <!-- Test1: 100% of bases with quality 33 or higher (pretty steep requirement...) -->
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
32 <param name="input" value="fastq_qual_filter1.fastq" ftype="fastqsolexa" />
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
33 <param name="quality" value="33"/>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
34 <param name="percent" value="100"/>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
35 <output name="output" ftype="fastqsolexa" file="fastq_qual_filter1a.out" />
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
36 </test>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
37 <test>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
38 <!-- Test2: 80% of bases with quality 20 or higher -->
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
39 <param name="input" value="fastq_qual_filter1.fastq" ftype="fastqsolexa"/>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
40 <param name="quality" value="20"/>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
41 <param name="percent" value="80"/>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
42 <output name="output" ftype="fastqsolexa" file="fastq_qual_filter1b.out" />
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
43 </test>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
44 </tests>
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
45 <help>
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
46 **What it does**
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
47
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
48 This tool filters reads based on quality scores.
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
49
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
50 .. class:: infomark
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
51
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
52 Using **percent = 100** requires all cycles of all reads to be at least the quality cut-off value.
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
53
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
54 .. class:: infomark
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
55
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
56 Using **percent = 50** requires the median quality of the cycles (in each read) to be at least the quality cut-off value.
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
57
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
58 --------
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
59
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
60 Quality score distribution (of all cycles) is calculated for each read. If it is lower than the quality cut-off value - the read is discarded.
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
61
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
62
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
63 **Example**::
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
64
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
65 @CSHL_4_FC042AGOOII:1:2:214:584
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
66 GACAATAAAC
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
67 +CSHL_4_FC042AGOOII:1:2:214:584
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
68 30 30 30 30 30 30 30 30 20 10
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
69
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
70 Using **percent = 50** and **cut-off = 30** - This read will not be discarded (the median quality is higher than 30).
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
71
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
72 Using **percent = 90** and **cut-off = 30** - This read will be discarded (90% of the cycles do no have quality equal to / higher than 30).
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
73
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
74 Using **percent = 100** and **cut-off = 20** - This read will be discarded (not all cycles have quality equal to / higher than 20).
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
75
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
76 ------
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
77
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
78 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
79
2
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
80 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
e41385662e5e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
81 </help>
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
82 <!-- FASTQ-Quality-Filter is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
83 </tool>