annotate fastq_quality_filter.xml @ 3:43a7370aa010 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
author iuc
date Tue, 08 May 2018 13:26:35 -0400
parents e41385662e5e
children 7b4468117008
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
1 <tool id="cshl_fastq_quality_filter" version="1.0.1" 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>
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
3 <macros>
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
4 <import>macros.xml</import>
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
5 </macros>
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
6 <expand macro="requirements" />
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
8 @CATS@ fastq_quality_filter
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
9 -q $quality
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
10 -p $percent
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
11 -v
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
12 -o '$output'
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
13 @FQQUAL@
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
14 ]]></command>
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
15
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
16 <inputs>
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
17 <expand macro="fastq_input" />
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
18
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
19 <param name="quality" type="integer" value="20" label="Quality cut-off value"/>
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
20
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
21 <param name="percent" type="integer" value="90"
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
22 label="Percent of bases in sequence that must have quality equal to / higher than cut-off value" />
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
23 </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
24 <outputs>
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
25 <data name="output" format_source="input" metadata_source="input" />
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
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 <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
28 <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
29 <!-- 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
30 <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
31 <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
32 <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
33 <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
34 </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
35 <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
36 <!-- 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
37 <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
38 <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
39 <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
40 <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
41 </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
42 </tests>
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
43 <help><![CDATA[
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
44 **What it does**
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
45
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
46 This tool filters reads based on quality scores.
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
47
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
48 .. class:: infomark
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
49
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
50 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
51
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
52 .. class:: infomark
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
53
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
54 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
55
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
56 --------
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
57
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
58 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
59
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
60
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
61 **Example**::
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
62
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
63 @CSHL_4_FC042AGOOII:1:2:214:584
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
64 GACAATAAAC
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 30 30 30 30 30 30 30 30 20 10
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
67
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
68 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
69
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
70 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
71
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
72 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
73
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
74 ------
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
75
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
76 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
77
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
78 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
3
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
79 ]]></help>
43a7370aa010 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/fastx_toolkit/fastq_quality_filter commit bbb2e6b6769b03602a8ab97001f88fbec52080a1
iuc
parents: 2
diff changeset
80 <expand macro="citations" />
0
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
81 <!-- FASTQ-Quality-Filter is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
b145b9b26648 Uploaded tool tarball.
devteam
parents:
diff changeset
82 </tool>