Mercurial > repos > nilesh > rseqc

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