Mercurial > repos > nilesh > rseqc

comparison read_distribution.xml @ 45:eb339c5849bb draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Reupload, toolshed removed all files of previous version.
author lparsons
date Fri, 26 Sep 2014 15:04:18 -0400
parents
children 6b33e31bda10
comparison
equal deleted inserted replaced
44:20e0b2dd7882 45:eb339c5849bb
1 <tool id="rseqc_read_distribution" name="Read Distribution" version="2.4">
2 <description>calculates how mapped reads were distributed over genome feature</description>
3 <requirements>
4 <requirement type="package" version="1.7.1">numpy</requirement>
5 <requirement type="package" version="2.4">rseqc</requirement>
6 </requirements>
7 <command>
8 read_distribution.py -i $input -r $refgene > $output
9 </command>
10 <stdio>
11 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
12 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
13 </stdio>
14 <inputs>
15 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
16 <param name="refgene" type="data" format="bed" label="reference gene model" />
17 </inputs>
18 <outputs>
19 <data format="txt" name="output" />
20 </outputs>
21 <help>
22 read_distribution.py
23 ++++++++++++++++++++
24
25 Provided a BAM/SAM file and reference gene model, this module will calculate how mapped
26 reads were distributed over genome feature (like CDS exon, 5'UTR exon, 3' UTR exon, Intron,
27 Intergenic regions). When genome features are overlapped (e.g. a region could be annotated
28 as both exon and intron by two different transcripts) , they are prioritize as:
29 CDS exons > UTR exons > Introns > Intergenic regions, for example, if a read was mapped to
30 both CDS exon and intron, it will be assigned to CDS exons.
31
32 * "Total Reads": This does NOT include those QC fail,duplicate and non-primary hit reads
33 * "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 Tags" >= "Total Reads"
34 * "Total Assigned Tags": number of tags that can be unambiguously assigned the 10 groups (see below table).
35 * 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.
36 * When assign tags to genome features, each tag is represented by its middle point.
37
38 RSeQC cannot assign those reads that:
39
40 * hit to intergenic regions that beyond region starting from TSS upstream 10Kb to TES downstream 10Kb.
41 * 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.
42 * hit to regions covered by both TSS upstream 10Kb and TES downstream 10Kb.
43
44
45 Inputs
46 ++++++++++++++
47
48 Input BAM/SAM file
49 Alignment file in BAM/SAM format.
50
51 Reference gene model
52 Gene model in BED format.
53
54 Sample Output
55 ++++++++++++++
56
57 Output:
58
59 =============== ============ =========== ===========
60 Group Total_bases Tag_count Tags/Kb
61 =============== ============ =========== ===========
62 CDS_Exons 33302033 20002271 600.63
63 5'UTR_Exons 21717577 4408991 203.01
64 3'UTR_Exons 15347845 3643326 237.38
65 Introns 1132597354 6325392 5.58
66 TSS_up_1kb 17957047 215331 11.99
67 TSS_up_5kb 81621382 392296 4.81
68 TSS_up_10kb 149730983 769231 5.14
69 TES_down_1kb 18298543 266161 14.55
70 TES_down_5kb 78900674 729997 9.25
71 TES_down_10kb 140361190 896882 6.39
72 =============== ============ =========== ===========
73
74 -----
75
76 About RSeQC
77 +++++++++++
78
79 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.
80
81 The RSeQC package is licensed under the GNU GPL v3 license.
82
83 .. image:: http://rseqc.sourceforge.net/_static/logo.png
84
85 .. _RSeQC: http://rseqc.sourceforge.net/
86
87
88
89 </help>
90 </tool>