annotate read_distribution.xml @ 2:ebadf9ee2d08

fixed dependencies
author nilesh
date Thu, 18 Jul 2013 11:01:08 -0500
parents f92b87abef3d
children 71ed55a3515a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
1 <tool id="read_distribution" name="Read Distribution">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
2 <description>calculates how mapped reads were distributed over genome feature</description>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
3 <requirements>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
4 <requirement type="package" version="2.3.7">rseqc</requirement>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
5 </requirements>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
6 <command interpreter="python"> read_distribution.py -i $input -r $refgene > $output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
7 </command>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
8 <inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
9 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
10 <param name="refgene" type="data" format="bed" label="reference gene model" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
11 </inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
12 <outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
13 <data format="txt" name="output" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
14 </outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
15 <help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
16 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
f92b87abef3d just xmls
nilesh
parents:
diff changeset
17
f92b87abef3d just xmls
nilesh
parents:
diff changeset
18 -----
f92b87abef3d just xmls
nilesh
parents:
diff changeset
19
f92b87abef3d just xmls
nilesh
parents:
diff changeset
20 About RSeQC
f92b87abef3d just xmls
nilesh
parents:
diff changeset
21 +++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
22
f92b87abef3d just xmls
nilesh
parents:
diff changeset
23 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.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
24
f92b87abef3d just xmls
nilesh
parents:
diff changeset
25 The RSeQC package is licensed under the GNU GPL v3 license.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
26
f92b87abef3d just xmls
nilesh
parents:
diff changeset
27 Inputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
28 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
29
f92b87abef3d just xmls
nilesh
parents:
diff changeset
30 Input BAM/SAM file
f92b87abef3d just xmls
nilesh
parents:
diff changeset
31 Alignment file in BAM/SAM format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
32
f92b87abef3d just xmls
nilesh
parents:
diff changeset
33 Reference gene model
f92b87abef3d just xmls
nilesh
parents:
diff changeset
34 Gene model in BED format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
35
f92b87abef3d just xmls
nilesh
parents:
diff changeset
36 Sample Output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
37 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
38
f92b87abef3d just xmls
nilesh
parents:
diff changeset
39 ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
40
f92b87abef3d just xmls
nilesh
parents:
diff changeset
41 Total Read: 44,826,454 ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
42
f92b87abef3d just xmls
nilesh
parents:
diff changeset
43 Total Tags: 50,023,249 ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
44
f92b87abef3d just xmls
nilesh
parents:
diff changeset
45 Total Assigned Tags: 36,057,402 ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
46
f92b87abef3d just xmls
nilesh
parents:
diff changeset
47 Group Total_bases Tag_count Tags/Kb
f92b87abef3d just xmls
nilesh
parents:
diff changeset
48 CDS_Exons 33302033 20022538 601.24
f92b87abef3d just xmls
nilesh
parents:
diff changeset
49 5'UTR_Exons 21717577 4414913 203.29
f92b87abef3d just xmls
nilesh
parents:
diff changeset
50 3'UTR_Exons 15347845 3641689 237.28
f92b87abef3d just xmls
nilesh
parents:
diff changeset
51 Introns 1132597354 6312099 5.57
f92b87abef3d just xmls
nilesh
parents:
diff changeset
52 TSS_up_1kb 17957047 215220 11.99
f92b87abef3d just xmls
nilesh
parents:
diff changeset
53 TSS_up_5kb 81621382 392192 4.81
f92b87abef3d just xmls
nilesh
parents:
diff changeset
54 TSS_up_10kb 149730983 769210 5.14
f92b87abef3d just xmls
nilesh
parents:
diff changeset
55 TES_down_1kb 18298543 266157 14.55
f92b87abef3d just xmls
nilesh
parents:
diff changeset
56 TES_down_5kb 78900674 730072 9.25
f92b87abef3d just xmls
nilesh
parents:
diff changeset
57 TES_down_10kb 140361190 896953 6.39
f92b87abef3d just xmls
nilesh
parents:
diff changeset
58
f92b87abef3d just xmls
nilesh
parents:
diff changeset
59 Note:
f92b87abef3d just xmls
nilesh
parents:
diff changeset
60 - "Total Reads": This does NOT include those QC fail,duplicate and non-primary hit reads
f92b87abef3d just xmls
nilesh
parents:
diff changeset
61 - "Total Tags": reads spliced once will be counted as 2 tags, reads spliced twice will be counted as 3 tags, etc. And because of this, "Total Fragments" >= "Total Reads"
f92b87abef3d just xmls
nilesh
parents:
diff changeset
62 - "Total Assigned Tags": number of tags that can be unambiguously assigned the 10 groups (above table).
f92b87abef3d just xmls
nilesh
parents:
diff changeset
63 - Tags assigned to "TSS_up_1kb" were also assigned to "TSS_up_5kb" and "TSS_up_10kb", tags assigned to "TSS_up_5kb" were also assigned to "TSS_up_10kb". Therefore, "Total Assigned Tags" = CDS_Exons + 5'UTR_Exons + 3'UTR_Exons + Introns + TSS_up_10kb + TES_down_10kb.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
64 - When assigning tags to genome features, each tag is represented by its middle point.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
65 - RSeQC cannot assign those reads that: 1) hit to intergenic regions that beyond region starting from TSS upstream 10Kb to TES downstream 10Kb. 2) hit to regions covered by both 5'UTR and 3' UTR. This is possible when two head-to-tail transcripts are overlapped in UTR regions. 3) hit to regions covered by both TSS upstream 10Kb and TES downstream 10Kb.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
66
f92b87abef3d just xmls
nilesh
parents:
diff changeset
67
f92b87abef3d just xmls
nilesh
parents:
diff changeset
68 </help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
69 </tool>