annotate read_quality.xml @ 31:cc5eaa9376d8

Lance's updates
author nilesh
date Wed, 02 Oct 2013 02:20:04 -0400
parents 907d4b021ff6
children 580ee0c4bc4e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
1 <tool id="read_quality" name="Read Quality" version="1.1">
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
2 <description>determines Phred quality score</description>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
3 <requirements>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
4 <requirement type="package" version="2.11.0">R</requirement>
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
7 </requirements>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
8 <command> read_quality.py -i $input -o output -r $reduce
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
9 </command>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
10 <inputs>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
11 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
12 <param name="reduce" type="integer" label="Ignore Phred scores less than this amount (only applies to 'boxplot', default=1000)" value="1000" />
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
13 </inputs>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
14 <outputs>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
15 <data format="r" name="outputr" from_work_dir="output.qual.r" label="${tool.name} on ${on_string} (R Script)" />
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
16 <data format="pdf" name="outputpdf" from_work_dir="output.qual.heatmap.pdf" label="${tool.name} on ${on_string} (Heatmap PDF)" />
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
17 <data format="pdf" name="outputpdf" from_work_dir="output.qual.boxplot.pdf" label="${tool.name} on ${on_string} (Boxplot PDF)" />
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
18 </outputs>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
19 <stdio>
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
20 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
21 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
22 </stdio>
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
23 <help>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
24 read_quality.py
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
25 +++++++++++++++
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
26
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
27 According to SAM specification, if Q is the character to represent "base calling quality"
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
28 in SAM file, then Phred Quality Score = ord(Q) - 33. Here ord() is python function that
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
29 returns an integer representing the Unicode code point of the character when the argument
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
30 is a unicode object, for example, ord('a') returns 97. Phred quality score is widely used
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
31 to measure "reliability" of base-calling, for example, phred quality score of 20 means
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
32 there is 1/100 chance that the base-calling is wrong, phred quality score of 30 means there
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
33 is 1/1000 chance that the base-calling is wrong. In general: Phred quality score = -10xlog(10)P,
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
34 here P is probability that base-calling is wrong.
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
35
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
36 Inputs
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
37 ++++++++++++++
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
38
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
39 Input BAM/SAM file
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
40 Alignment file in BAM/SAM format.
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
41
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
42 Ignore phred scores less than this number (default=1000)
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
43 To avoid making huge vector in R, nucleotide with certain phred score represented less than this number will be ignored. Increase this number save more memory while reduce precision. This option only applies to the 'boxplot'.
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
44
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
45 Output
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
46 ++++++++++++++
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
47
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
48 1. output.qual.r
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
49 2. output.qual.boxplot.pdf
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
50 .. image:: http://rseqc.sourceforge.net/_images/36mer.qual.plot.png
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
51 :height: 600 px
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
52 :width: 600 px
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
53 :scale: 80 %
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
54 3. output.qual.heatmap.pdf
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
55 .. image:: http://rseqc.sourceforge.net/_images/36mer.qual.heatmap.png
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
56 :height: 600 px
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
57 :width: 600 px
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
58 :scale: 80 %
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
59
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
60 Heatmap: use different color to represent nucleotide density ("blue"=low density,"orange"=median density,"red"=high density")
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
61
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
62 -----
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
63
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
64 About RSeQC
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
65 +++++++++++
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
66
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
67 The RSeQC_ package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. "Basic modules" quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while "RNA-seq specific modules" investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
68
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
69 The RSeQC package is licensed under the GNU GPL v3 license.
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
70
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
71 .. image:: http://rseqc.sourceforge.net/_static/logo.png
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
72
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
73 .. _RSeQC: http://rseqc.sourceforge.net/
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
74
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
75
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
76 </help>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
77 </tool>