annotate junction_saturation.xml @ 24:80f857718ca0

Uploaded
author nilesh
date Thu, 11 Jul 2013 12:25:28 -0400
parents d064a3014efd
children cc5eaa9376d8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
d064a3014efd Uploaded
nilesh
parents:
diff changeset
1 <tool id="junction_saturation" name="Junction Saturation">
d064a3014efd Uploaded
nilesh
parents:
diff changeset
2 <description>detects splice junctions from each subset and compares them to reference gene model</description>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
3 <requirements>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
4 <requirement type="package" version="2.15.1">R</requirement>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
5 <requirement type="package" version="2.3.7">rseqc</requirement>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
6 </requirements>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
7 <command interpreter="python"> junction_saturation.py -i $input -o output -r $refgene -m $intronSize -v $minSplice
d064a3014efd Uploaded
nilesh
parents:
diff changeset
8
d064a3014efd Uploaded
nilesh
parents:
diff changeset
9 #if $percentiles.specifyPercentiles
d064a3014efd Uploaded
nilesh
parents:
diff changeset
10 -l $percentiles.lowBound -u $percentiles.upBound -s $percentiles.percentileStep
d064a3014efd Uploaded
nilesh
parents:
diff changeset
11 #end if
d064a3014efd Uploaded
nilesh
parents:
diff changeset
12
d064a3014efd Uploaded
nilesh
parents:
diff changeset
13 </command>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
14 <inputs>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
15 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
d064a3014efd Uploaded
nilesh
parents:
diff changeset
16 <param name="refgene" type="data" format="bed" label="reference gene model" />
d064a3014efd Uploaded
nilesh
parents:
diff changeset
17 <param name="intronSize" type="integer" label="Minimum intron size (bp, default=50)" value="50"/>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
18 <param name="minSplice" type="integer" label="Minimum coverage (default=1)" value="1" />
d064a3014efd Uploaded
nilesh
parents:
diff changeset
19 <conditional name="percentiles">
d064a3014efd Uploaded
nilesh
parents:
diff changeset
20 <param name="specifyPercentiles" type="boolean" label="Specify sampling bounds and frequency" value="false"/>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
21 <when value="true">
d064a3014efd Uploaded
nilesh
parents:
diff changeset
22 <param name="lowBound" type="integer" value="5" label="Lower Bound Sampling Frequency (bp, default=5)" />
d064a3014efd Uploaded
nilesh
parents:
diff changeset
23 <param name="upBound" type="integer" value="100" label="Upper Bound Sampling Frequency (bp, default=100)" />
d064a3014efd Uploaded
nilesh
parents:
diff changeset
24 <param name="percentileStep" type="integer" value="5" label="Sampling increment (default=5)" />
d064a3014efd Uploaded
nilesh
parents:
diff changeset
25 </when>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
26 </conditional>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
27 </inputs>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
28 <outputs>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
29 <data format="r" name="outputr" from_work_dir="output.junctionSaturation_plot.r"/>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
30 <data format="pdf" name="outputpdf" from_work_dir="output.junctionSaturation_plot.pdf"/>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
31 </outputs>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
32 <help>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
33 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
d064a3014efd Uploaded
nilesh
parents:
diff changeset
34
d064a3014efd Uploaded
nilesh
parents:
diff changeset
35 -----
d064a3014efd Uploaded
nilesh
parents:
diff changeset
36
d064a3014efd Uploaded
nilesh
parents:
diff changeset
37 About RSeQC
d064a3014efd Uploaded
nilesh
parents:
diff changeset
38 +++++++++++
d064a3014efd Uploaded
nilesh
parents:
diff changeset
39
d064a3014efd Uploaded
nilesh
parents:
diff changeset
40 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.
d064a3014efd Uploaded
nilesh
parents:
diff changeset
41
d064a3014efd Uploaded
nilesh
parents:
diff changeset
42 The RSeQC package is licensed under the GNU GPL v3 license.
d064a3014efd Uploaded
nilesh
parents:
diff changeset
43
d064a3014efd Uploaded
nilesh
parents:
diff changeset
44 Inputs
d064a3014efd Uploaded
nilesh
parents:
diff changeset
45 ++++++++++++++
d064a3014efd Uploaded
nilesh
parents:
diff changeset
46
d064a3014efd Uploaded
nilesh
parents:
diff changeset
47 Input BAM/SAM file
d064a3014efd Uploaded
nilesh
parents:
diff changeset
48 Alignment file in BAM/SAM format.
d064a3014efd Uploaded
nilesh
parents:
diff changeset
49
d064a3014efd Uploaded
nilesh
parents:
diff changeset
50 Reference gene model
d064a3014efd Uploaded
nilesh
parents:
diff changeset
51 Gene model in BED format.
d064a3014efd Uploaded
nilesh
parents:
diff changeset
52
d064a3014efd Uploaded
nilesh
parents:
diff changeset
53 Sampling Percentiles - Upper Bound, Lower Bound, Sampling Increment (defaults= 100, 5, and 5)
d064a3014efd Uploaded
nilesh
parents:
diff changeset
54 Sampling starts from the Lower Bound and increments to the Upper Bound at the rate of the Sampling Increment.
d064a3014efd Uploaded
nilesh
parents:
diff changeset
55
d064a3014efd Uploaded
nilesh
parents:
diff changeset
56 Minimum intron length (default=50)
d064a3014efd Uploaded
nilesh
parents:
diff changeset
57 Minimum intron length (bp).
d064a3014efd Uploaded
nilesh
parents:
diff changeset
58
d064a3014efd Uploaded
nilesh
parents:
diff changeset
59 Minimum coverage (default=1)
d064a3014efd Uploaded
nilesh
parents:
diff changeset
60 Minimum number of supportting reads to call a junction.
d064a3014efd Uploaded
nilesh
parents:
diff changeset
61
d064a3014efd Uploaded
nilesh
parents:
diff changeset
62 Output
d064a3014efd Uploaded
nilesh
parents:
diff changeset
63 ++++++++++++++
d064a3014efd Uploaded
nilesh
parents:
diff changeset
64
d064a3014efd Uploaded
nilesh
parents:
diff changeset
65 1. output.junctionSaturation_plot.r: R script to generate plot
d064a3014efd Uploaded
nilesh
parents:
diff changeset
66 2. output.junctionSaturation_plot.pdf
d064a3014efd Uploaded
nilesh
parents:
diff changeset
67
d064a3014efd Uploaded
nilesh
parents:
diff changeset
68 .. image:: http://dldcc-web.brc.bcm.edu/lilab/liguow/RSeQC/figure/junction_saturation.png
d064a3014efd Uploaded
nilesh
parents:
diff changeset
69
d064a3014efd Uploaded
nilesh
parents:
diff changeset
70 In this example, current sequencing depth is almost saturated for "known junction" (red line) detection because the number of "known junction" reaches a plateau. In other words, nearly all "known junctions" (expressed in this particular tissue) have already been detected, and continue sequencing will not detect additional "known junction" and will only increase junction coverage (i.e. junction covered by more reads). While current sequencing depth is not saturated for novel junctions (green).
d064a3014efd Uploaded
nilesh
parents:
diff changeset
71
d064a3014efd Uploaded
nilesh
parents:
diff changeset
72
d064a3014efd Uploaded
nilesh
parents:
diff changeset
73 </help>
d064a3014efd Uploaded
nilesh
parents:
diff changeset
74 </tool>