annotate tools/fastx_toolkit/fastx_quality_statistics.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="cshl_fastx_quality_statistics" name="Compute quality statistics">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description></description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <requirements><requirement type="package">fastx_toolkit</requirement></requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <command>zcat -f $input | fastx_quality_stats -o $output -Q 33</command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <param format="fastqsanger" name="input" type="data" label="Library to analyse" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <param name="input" value="fastq_stats1.fastq" ftype="fastqsanger"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <output name="output" file="fastq_stats1.out" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <data format="txt" name="output" metadata_source="input" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 Creates quality statistics report for the given Solexa/FASTQ library.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 **TIP:** This statistics report can be used as input for **Quality Score** and **Nucleotides Distribution** tools.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 **The output file will contain the following fields:**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 * column = column number (1 to 36 for a 36-cycles read Solexa file)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 * count = number of bases found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 * min = Lowest quality score value found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 * max = Highest quality score value found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 * sum = Sum of quality score values for this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 * mean = Mean quality score value for this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 * Q1 = 1st quartile quality score.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 * med = Median quality score.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 * Q3 = 3rd quartile quality score.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 * IQR = Inter-Quartile range (Q3-Q1).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 * lW = 'Left-Whisker' value (for boxplotting).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 * rW = 'Right-Whisker' value (for boxplotting).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 * A_Count = Count of 'A' nucleotides found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 * C_Count = Count of 'C' nucleotides found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 * G_Count = Count of 'G' nucleotides found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 * T_Count = Count of 'T' nucleotides found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 * N_Count = Count of 'N' nucleotides found in this column.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 For example::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 1 6362991 -4 40 250734117 39.41 40 40 40 0 40 40 1396976 1329101 678730 2958184 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 2 6362991 -5 40 250531036 39.37 40 40 40 0 40 40 1786786 1055766 1738025 1782414 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 3 6362991 -5 40 248722469 39.09 40 40 40 0 40 40 2296384 984875 1443989 1637743 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 4 6362991 -4 40 248214827 39.01 40 40 40 0 40 40 2536861 1167423 1248968 1409739 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 36 6362991 -5 40 117158566 18.41 7 15 30 23 -5 40 4074444 1402980 63287 822035 245
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 </tool>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 <!-- FASTQ-Statistics is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->