annotate read_quality.xml @ 38:a447651be8ee

Reupload 2.3.7 fix (tarball upload issues)
author lparsons
date Wed, 23 Jul 2014 10:14:01 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
1 <tool id="rseqc_read_quality" name="Read Quality" version="1.1">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
2 <description>determines Phred quality score</description>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
3 <requirements>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
4 <requirement type="package" version="3.0.1">R</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
7 </requirements>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
8 <command>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
9 read_quality.py -i $input -o output -r $reduce
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
10 </command>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
11 <stdio>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
12 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
13 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
14 </stdio>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
15 <inputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
16 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
17 <param name="reduce" type="integer" label="Ignore Phred scores less than this amount (only applies to 'boxplot', default=1000)" value="1000" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
18 </inputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
19 <outputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
20 <data format="txt" name="outputr" from_work_dir="output.qual.r" label="${tool.name} on ${on_string} (R Script)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
21 <data format="pdf" name="outputpdf" from_work_dir="output.qual.heatmap.pdf" label="${tool.name} on ${on_string} (Heatmap PDF)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
22 <data format="pdf" name="outputpdf" from_work_dir="output.qual.boxplot.pdf" label="${tool.name} on ${on_string} (Boxplot PDF)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
23 </outputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
24 <help>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
25 read_quality.py
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
26 +++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
27
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
28 According to SAM specification, if Q is the character to represent "base calling quality"
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
29 in SAM file, then Phred Quality Score = ord(Q) - 33. Here ord() is python function that
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
30 returns an integer representing the Unicode code point of the character when the argument
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
31 is a unicode object, for example, ord('a') returns 97. Phred quality score is widely used
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
32 to measure "reliability" of base-calling, for example, phred quality score of 20 means
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
33 there is 1/100 chance that the base-calling is wrong, phred quality score of 30 means there
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
34 is 1/1000 chance that the base-calling is wrong. In general: Phred quality score = -10xlog(10)P,
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
35 here P is probability that base-calling is wrong.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
36
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
37 Inputs
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
38 ++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
39
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
40 Input BAM/SAM file
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
41 Alignment file in BAM/SAM format.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
42
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
43 Ignore phred scores less than this number (default=1000)
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
44 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'.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
45
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
46 Output
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
47 ++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
48
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
49 1. output.qual.r
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
50 2. output.qual.boxplot.pdf
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
51 .. image:: http://rseqc.sourceforge.net/_images/36mer.qual.plot.png
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
52 :height: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
53 :width: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
54 :scale: 80 %
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
55 3. output.qual.heatmap.pdf
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
56 .. image:: http://rseqc.sourceforge.net/_images/36mer.qual.heatmap.png
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
57 :height: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
58 :width: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
59 :scale: 80 %
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
60
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
61 Heatmap: use different color to represent nucleotide density ("blue"=low density,"orange"=median density,"red"=high density")
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
62
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
63 -----
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
64
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
65 About RSeQC
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
66 +++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
67
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
68 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.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
69
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
70 The RSeQC package is licensed under the GNU GPL v3 license.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
71
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
72 .. image:: http://rseqc.sourceforge.net/_static/logo.png
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
73
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
74 .. _RSeQC: http://rseqc.sourceforge.net/
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
75
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
76
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
77 </help>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
78 </tool>