annotate RPKM_saturation.xml @ 1:f92b87abef3d

just xmls
author nilesh
date Thu, 18 Jul 2013 10:54:06 -0500
parents
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="RPKM_saturation" name="RPKM Saturation">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
2 <description>calculates raw count and RPKM values for transcript at exon, intron, and mRNA level</description>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
3 <requirements>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
4 <requirement type="package" version="2.15.1">R</requirement>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
5 <requirement type="package" version="2.3.7">rseqc</requirement>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
6 </requirements>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
7 <command interpreter="python"> RPKM_saturation.py -i $input -o output -r $refgene
f92b87abef3d just xmls
nilesh
parents:
diff changeset
8
f92b87abef3d just xmls
nilesh
parents:
diff changeset
9 #if str($strand_type.strand_specific) == "pair"
f92b87abef3d just xmls
nilesh
parents:
diff changeset
10 -d
f92b87abef3d just xmls
nilesh
parents:
diff changeset
11 #if str($strand_type.pair_type) == "sd"
f92b87abef3d just xmls
nilesh
parents:
diff changeset
12 '1++,1--,2+-,2-+'
f92b87abef3d just xmls
nilesh
parents:
diff changeset
13 #else
f92b87abef3d just xmls
nilesh
parents:
diff changeset
14 '1+-,1-+,2++,2--'
f92b87abef3d just xmls
nilesh
parents:
diff changeset
15 #end if
f92b87abef3d just xmls
nilesh
parents:
diff changeset
16 #end if
f92b87abef3d just xmls
nilesh
parents:
diff changeset
17
f92b87abef3d just xmls
nilesh
parents:
diff changeset
18 #if str($strand_type.strand_specific) == "single"
f92b87abef3d just xmls
nilesh
parents:
diff changeset
19 -d
f92b87abef3d just xmls
nilesh
parents:
diff changeset
20 #if str($strand_type.single_type) == "s"
f92b87abef3d just xmls
nilesh
parents:
diff changeset
21 '++,--'
f92b87abef3d just xmls
nilesh
parents:
diff changeset
22 #else
f92b87abef3d just xmls
nilesh
parents:
diff changeset
23 '+-,-+'
f92b87abef3d just xmls
nilesh
parents:
diff changeset
24 #end if
f92b87abef3d just xmls
nilesh
parents:
diff changeset
25 #end if
f92b87abef3d just xmls
nilesh
parents:
diff changeset
26
f92b87abef3d just xmls
nilesh
parents:
diff changeset
27 -l $percentileFloor -u $percentileCeiling -s $percentileStep -c $rpkmCutoff
f92b87abef3d just xmls
nilesh
parents:
diff changeset
28
f92b87abef3d just xmls
nilesh
parents:
diff changeset
29 </command>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
30 <inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
31 <param name="input" type="data" format="bam" label="input bam/sam file" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
32 <param name="refgene" type="data" format="bed" label="Reference gene model" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
33 <conditional name="strand_type">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
34 <param name="strand_specific" type="select" label="Strand-specific?" value="None">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
35 <option value="none">None</option>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
36 <option value="pair">Pair-End RNA-seq</option>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
37 <option value="single">Single-End RNA-seq</option>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
38 </param>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
39 <when value="pair">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
40 <param name="pair_type" type="select" display="radio" label="Pair-End Read Type (format: mapped --> parent)" value="sd">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
41 <option value="sd"> read1 (positive --> positive; negative --> negative), read2 (positive --> negative; negative --> positive)</option>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
42 <option value="ds">read1 (positive --> negative; negative --> positive), read2 (positive --> positive; negative --> negative)</option>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
43 </param>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
44 </when>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
45 <when value="single">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
46 <param name="single_type" type="select" display="radio" label="Single-End Read Type (format: mapped --> parent)" value="s">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
47 <option value="s">positive --> positive; negative --> negative</option>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
48 <option value="d">positive --> negative; negative --> positive</option>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
49 </param>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
50 </when>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
51 <when value="none"></when>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
52 </conditional>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
53 <param name="percentileFloor" type="integer" value="5" label="Begin sampling from this percentile (default=5)" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
54 <param name="percentileCeiling" type="integer" value="100" label="End sampling at this percentile (default=100)" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
55 <param name="percentileStep" type="integer" value="5" label="Sampling step size (default=5)" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
56 <param name="rpkmCutoff" type="text" value="0.01" label="Ignore transcripts with RPKM smaller than this number (default=0.01)" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
57 </inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
58 <outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
59 <data format="xls" name="outputxls" from_work_dir="output.eRPKM.xls"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
60 <data format="xls" name="outputrawxls" from_work_dir="output.rawCount.xls"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
61 <data format="r" name="outputr" from_work_dir="output.saturation.r"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
62 <data format="pdf" name="outputpdf" from_work_dir="output.saturation.pdf"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
63 </outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
64 <tests>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
65 <test>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
66 <param name="input" value="Pairend_nonStrandSpecific_36mer_Human_hg19.bam" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
67 <param name="refgene" value="hg19_RefSeq.bed" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
68 <output name="outputxls" file="rpkmsatout.eRPKM.xls" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
69 <output name="outputrawxls" file="rpkmsatout.rawCount.xls" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
70 <output name="outputr" file="rpkmsatout.saturation.r" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
71 <output name="outputpdf" file="rpkmsatout.saturation.pdf" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
72 </test>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
73 </tests>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
74 <help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
75 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
f92b87abef3d just xmls
nilesh
parents:
diff changeset
76
f92b87abef3d just xmls
nilesh
parents:
diff changeset
77 -----
f92b87abef3d just xmls
nilesh
parents:
diff changeset
78
f92b87abef3d just xmls
nilesh
parents:
diff changeset
79 About RSeQC
f92b87abef3d just xmls
nilesh
parents:
diff changeset
80 +++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
81
f92b87abef3d just xmls
nilesh
parents:
diff changeset
82 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
83
f92b87abef3d just xmls
nilesh
parents:
diff changeset
84 The RSeQC package is licensed under the GNU GPL v3 license.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
85
f92b87abef3d just xmls
nilesh
parents:
diff changeset
86 Inputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
87 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
88
f92b87abef3d just xmls
nilesh
parents:
diff changeset
89 Input BAM/SAM file
f92b87abef3d just xmls
nilesh
parents:
diff changeset
90 Alignment file in BAM/SAM format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
91
f92b87abef3d just xmls
nilesh
parents:
diff changeset
92 Reference gene model
f92b87abef3d just xmls
nilesh
parents:
diff changeset
93 Gene model in BED format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
94
f92b87abef3d just xmls
nilesh
parents:
diff changeset
95 Strand sequencing type (default=none)
f92b87abef3d just xmls
nilesh
parents:
diff changeset
96 See Infer Experiment tool if uncertain.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
97
f92b87abef3d just xmls
nilesh
parents:
diff changeset
98 Options
f92b87abef3d just xmls
nilesh
parents:
diff changeset
99 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
100
f92b87abef3d just xmls
nilesh
parents:
diff changeset
101 Skip Multiple Hit Reads
f92b87abef3d just xmls
nilesh
parents:
diff changeset
102 Use Multiple hit reads or use only uniquely mapped reads.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
103
f92b87abef3d just xmls
nilesh
parents:
diff changeset
104 Only use exonic reads
f92b87abef3d just xmls
nilesh
parents:
diff changeset
105 Renders program only used exonic (UTR exons and CDS exons) reads, otherwise use all reads.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
106
f92b87abef3d just xmls
nilesh
parents:
diff changeset
107 Output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
108 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
109
f92b87abef3d just xmls
nilesh
parents:
diff changeset
110 1. output..eRPKM.xls: RPKM values for each transcript
f92b87abef3d just xmls
nilesh
parents:
diff changeset
111 2. output.rawCount.xls: Raw count for each transcript
f92b87abef3d just xmls
nilesh
parents:
diff changeset
112 3. output.saturation.r: R script to generate plot
f92b87abef3d just xmls
nilesh
parents:
diff changeset
113 4. output.saturation.pdf:
f92b87abef3d just xmls
nilesh
parents:
diff changeset
114
f92b87abef3d just xmls
nilesh
parents:
diff changeset
115 .. image:: http://dldcc-web.brc.bcm.edu/lilab/liguow/RSeQC/figure/saturation.png
f92b87abef3d just xmls
nilesh
parents:
diff changeset
116
f92b87abef3d just xmls
nilesh
parents:
diff changeset
117 - All transcripts were sorted in ascending order according to expression level (RPKM). Then they are divided into 4 groups:
f92b87abef3d just xmls
nilesh
parents:
diff changeset
118 1. Q1 (0-25%): Transcripts with expression level ranked below 25 percentile.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
119 2. Q2 (25-50%): Transcripts with expression level ranked between 25 percentile and 50 percentile.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
120 3. Q3 (50-75%): Transcripts with expression level ranked between 50 percentile and 75 percentile.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
121 4. Q4 (75-100%): Transcripts with expression level ranked above 75 percentile.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
122 - BAM/SAM file containing more than 100 million alignments will make module very slow.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
123 - Follow example below to visualize a particular transcript (using R console)::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
124 - output example
f92b87abef3d just xmls
nilesh
parents:
diff changeset
125 .. image:: http://dldcc-web.brc.bcm.edu/lilab/liguow/RSeQC/figure/saturation_eg.png
f92b87abef3d just xmls
nilesh
parents:
diff changeset
126
f92b87abef3d just xmls
nilesh
parents:
diff changeset
127 </help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
128 </tool>