annotate read_quality.xml @ 40:1e66f05a23aa

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