annotate junction_saturation.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="junction_saturation" name="Junction Saturation">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
2 <description>detects splice junctions from each subset and compares them to reference gene model</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"> junction_saturation.py -i $input -o output -r $refgene -m $intronSize -v $minSplice
f92b87abef3d just xmls
nilesh
parents:
diff changeset
8
f92b87abef3d just xmls
nilesh
parents:
diff changeset
9 #if $percentiles.specifyPercentiles
f92b87abef3d just xmls
nilesh
parents:
diff changeset
10 -l $percentiles.lowBound -u $percentiles.upBound -s $percentiles.percentileStep
f92b87abef3d just xmls
nilesh
parents:
diff changeset
11 #end if
f92b87abef3d just xmls
nilesh
parents:
diff changeset
12
f92b87abef3d just xmls
nilesh
parents:
diff changeset
13 </command>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
14 <inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
15 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
16 <param name="refgene" type="data" format="bed" label="reference gene model" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
17 <param name="intronSize" type="integer" label="Minimum intron size (bp, default=50)" value="50"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
18 <param name="minSplice" type="integer" label="Minimum coverage (default=1)" value="1" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
19 <conditional name="percentiles">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
20 <param name="specifyPercentiles" type="boolean" label="Specify sampling bounds and frequency" value="false"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
21 <when value="true">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
22 <param name="lowBound" type="integer" value="5" label="Lower Bound Sampling Frequency (bp, default=5)" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
23 <param name="upBound" type="integer" value="100" label="Upper Bound Sampling Frequency (bp, default=100)" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
24 <param name="percentileStep" type="integer" value="5" label="Sampling increment (default=5)" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
25 </when>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
26 </conditional>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
27 </inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
28 <outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
29 <data format="r" name="outputr" from_work_dir="output.junctionSaturation_plot.r"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
30 <data format="pdf" name="outputpdf" from_work_dir="output.junctionSaturation_plot.pdf"/>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
31 </outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
32 <tests>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
33 <test>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
34 <param name="input" value="Pairend_nonStrandSpecific_36mer_Human_hg19.bam" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
35 <param name="refgene" value="hg19_RefSeq.bed" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
36 <output name="outputr" file="junsatout.junctionSaturation_plot.r" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
37 <output name="outputpdf" file="junsatout.junctionSaturation_plot.pdf" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
38 </test>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
39 </tests>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
40 <help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
41 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
f92b87abef3d just xmls
nilesh
parents:
diff changeset
42
f92b87abef3d just xmls
nilesh
parents:
diff changeset
43 -----
f92b87abef3d just xmls
nilesh
parents:
diff changeset
44
f92b87abef3d just xmls
nilesh
parents:
diff changeset
45 About RSeQC
f92b87abef3d just xmls
nilesh
parents:
diff changeset
46 +++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
47
f92b87abef3d just xmls
nilesh
parents:
diff changeset
48 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
49
f92b87abef3d just xmls
nilesh
parents:
diff changeset
50 The RSeQC package is licensed under the GNU GPL v3 license.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
51
f92b87abef3d just xmls
nilesh
parents:
diff changeset
52 Inputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
53 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
54
f92b87abef3d just xmls
nilesh
parents:
diff changeset
55 Input BAM/SAM file
f92b87abef3d just xmls
nilesh
parents:
diff changeset
56 Alignment file in BAM/SAM format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
57
f92b87abef3d just xmls
nilesh
parents:
diff changeset
58 Reference gene model
f92b87abef3d just xmls
nilesh
parents:
diff changeset
59 Gene model in BED format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
60
f92b87abef3d just xmls
nilesh
parents:
diff changeset
61 Sampling Percentiles - Upper Bound, Lower Bound, Sampling Increment (defaults= 100, 5, and 5)
f92b87abef3d just xmls
nilesh
parents:
diff changeset
62 Sampling starts from the Lower Bound and increments to the Upper Bound at the rate of the Sampling Increment.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
63
f92b87abef3d just xmls
nilesh
parents:
diff changeset
64 Minimum intron length (default=50)
f92b87abef3d just xmls
nilesh
parents:
diff changeset
65 Minimum intron length (bp).
f92b87abef3d just xmls
nilesh
parents:
diff changeset
66
f92b87abef3d just xmls
nilesh
parents:
diff changeset
67 Minimum coverage (default=1)
f92b87abef3d just xmls
nilesh
parents:
diff changeset
68 Minimum number of supportting reads to call a junction.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
69
f92b87abef3d just xmls
nilesh
parents:
diff changeset
70 Output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
71 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
72
f92b87abef3d just xmls
nilesh
parents:
diff changeset
73 1. output.junctionSaturation_plot.r: R script to generate plot
f92b87abef3d just xmls
nilesh
parents:
diff changeset
74 2. output.junctionSaturation_plot.pdf
f92b87abef3d just xmls
nilesh
parents:
diff changeset
75
f92b87abef3d just xmls
nilesh
parents:
diff changeset
76 .. image:: http://dldcc-web.brc.bcm.edu/lilab/liguow/RSeQC/figure/junction_saturation.png
f92b87abef3d just xmls
nilesh
parents:
diff changeset
77
f92b87abef3d just xmls
nilesh
parents:
diff changeset
78 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).
f92b87abef3d just xmls
nilesh
parents:
diff changeset
79
f92b87abef3d just xmls
nilesh
parents:
diff changeset
80
f92b87abef3d just xmls
nilesh
parents:
diff changeset
81 </help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
82 </tool>