annotate fastq_quality_boxplot.xml @ 1:f95284aa2946

Add missing help images.
author Dave Bouvier <dave@bx.psu.edu>
date Mon, 21 Jul 2014 15:11:49 -0400
parents e359ce20fbd9
children 3987db70a4b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="cshl_fastq_quality_boxplot" name="Draw quality score boxplot" version="1.0.0">
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description></description>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
6 <command>fastq_quality_boxplot_graph.sh -t '$input.name' -i $input -o $output</command>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
7
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
8 <inputs>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
9 <param format="txt" name="input" type="data" label="Statistics report file" help="output of 'FASTQ Statistics' tool" />
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
10 </inputs>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
11
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
12 <outputs>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
13 <data format="png" name="output" metadata_source="input" />
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
14 </outputs>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
15 <help>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
16
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
17 **What it does**
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
18
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
19 Creates a boxplot graph for the quality scores in the library.
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
20
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
21 .. class:: infomark
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
22
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
23 **TIP:** Use the **FASTQ Statistics** tool to generate the report file needed for this tool.
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
24
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
25 -----
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
26
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
27 **Output Examples**
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
28
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
29 * Black horizontal lines are medians
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
30 * Rectangular red boxes show the Inter-quartile Range (IQR) (top value is Q3, bottom value is Q1)
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
31 * Whiskers show outlier at max. 1.5*IQR
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
32
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
33
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
34 An excellent quality library (median quality is 40 for almost all 36 cycles):
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
35
1
f95284aa2946 Add missing help images.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
36 .. image:: fastq_quality_boxplot_1.png
0
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
37
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
38
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
39 A relatively good quality library (median quality degrades towards later cycles):
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
40
1
f95284aa2946 Add missing help images.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
41 .. image:: fastq_quality_boxplot_2.png
0
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
42
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
43 A low quality library (median drops quickly):
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
44
1
f95284aa2946 Add missing help images.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
45 .. image:: fastq_quality_boxplot_3.png
0
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
46
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
47 ------
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
48
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
49 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
50
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
51 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
52
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
53
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
54
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
55 </help>
e359ce20fbd9 Uploaded tool tarball.
devteam
parents:
diff changeset
56 <!-- FASTQ-Quality-Boxplot is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
1
f95284aa2946 Add missing help images.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
57 </tool>