annotate tools/solid_tools/solid_qual_stats.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="solid_qual_stats" name="Compute quality statistics" version="1.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>for SOLiD data</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">solid_qual_stats.py $input $output1</command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <param format="qualsolid" name="input" type="data" label="SOLiD qual file" help="If your dataset doesn't show up in the menu, click the pencil icon next to your dataset and set the datatype to 'qualsolid'" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <data format="txt" name="output1" metadata_source="input" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <param name="input" value="qualscores.qualsolid" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <output name="output1" file="qualsolid.stats" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 Creates quality statistics report for the given SOLiD quality score file.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 **TIP:** This statistics report can be used as input for **Quality Boxplot for SOLiD data** tool.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 **The output file will contain the following fields:**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 * column = column number (position on the read)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 * count = number of bases found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 * min = Lowest quality score value found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 * max = Highest quality score value found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 * sum = Sum of quality score values for this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 * mean = Mean quality score value for this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 * Q1 = 1st quartile quality score.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 * med = Median quality score.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 * Q3 = 3rd quartile quality score.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 * IQR = Inter-Quartile range (Q3-Q1).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 * lW = 'Left-Whisker' value (for boxplotting).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 * rW = 'Right-Whisker' value (for boxplotting).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 **Output Example**::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 column count min max sum mean Q1 med Q3 IQR lW rW
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 1 6362991 2 32 250734117 20.41 5 9 28 23 2 31
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 2 6362991 2 32 250531036 21.37 10 26 30 20 5 31
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 3 6362991 2 34 248722469 19.09 10 26 30 20 5 31
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 4 6362991 2 34 247654797 18.92 10 26 30 20 5 31
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 .
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 .
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 32 6362991 2 31 143436943 16.54 3 10 25 22 2 31
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 33 6362991 2 32 114269843 16.96 3 10 25 22 2 31
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 34 6362991 2 29 140638447 12.10 3 10 25 22 2 29
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 35 6362991 2 29 138910532 11.83 3 10 25 22 2 29
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 </tool>