annotate junction_saturation.xml @ 0:f85fac5a4dce draft

Import from BitBucket tip
author lparsons
date Mon, 07 Oct 2013 14:36:38 -0400
parents
children 5eef4ef0ab25
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
1 <tool id="rseqc_junction_saturation" name="Junction Saturation" version="1.1">
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
2 <description>detects splice junctions from each subset and compares them to reference gene model</description>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
3 <requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
4 <requirement type="package" version="2.11.0">R</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
7 </requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
8 <command> junction_saturation.py -i $input -o output -r $refgene -m $intronSize -v $minSplice
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
9
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
10 #if $percentiles.specifyPercentiles
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
11 -l $percentiles.lowBound -u $percentiles.upBound -s $percentiles.percentileStep
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
12 #end if
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
13
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
14 </command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
15 <stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
16 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
17 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
18 </stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
19 <inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
20 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
21 <param name="refgene" type="data" format="bed" label="reference gene model" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
22 <param name="intronSize" type="integer" label="Minimum intron size (bp, default=50)" value="50"/>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
23 <param name="minSplice" type="integer" label="Minimum coverage (default=1)" value="1" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
24 <conditional name="percentiles">
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
25 <param name="specifyPercentiles" type="boolean" label="Specify sampling bounds and frequency" value="false"/>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
26 <when value="true">
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
27 <param name="lowBound" type="integer" value="5" label="Lower Bound Sampling Frequency (bp, default=5)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
28 <param name="upBound" type="integer" value="100" label="Upper Bound Sampling Frequency (bp, default=100)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
29 <param name="percentileStep" type="integer" value="5" label="Sampling increment (default=5)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
30 </when>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
31 </conditional>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
32 </inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
33 <outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
34 <data format="txt" name="outputr" from_work_dir="output.junctionSaturation_plot.r" label="${tool.name} on ${on_string} (R Script)"/>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
35 <data format="pdf" name="outputpdf" from_work_dir="output.junctionSaturation_plot.pdf" label="${tool.name} on ${on_string} (PDF)"/>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
36 </outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
37 <help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
38 junction_saturation.py
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
39 ++++++++++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
40
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
41 It's very important to check if current sequencing depth is deep enough to perform
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
42 alternative splicing analyses. For a well annotated organism, the number of expressed genes
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
43 in particular tissue is almost fixed so the number of splice junctions is also fixed. The fixed
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
44 splice junctions can be predetermined from reference gene model. All (annotated) splice
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
45 junctions should be rediscovered from a saturated RNA-seq data, otherwise, downstream
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
46 alternative splicing analysis is problematic because low abundance splice junctions are
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
47 missing. This module checks for saturation by resampling 5%, 10%, 15%, ..., 95% of total
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
48 alignments from BAM or SAM file, and then detects splice junctions from each subset and
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
49 compares them to reference gene model.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
50
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
51 Inputs
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
52 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
53
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
54 Input BAM/SAM file
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
55 Alignment file in BAM/SAM format.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
56
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
57 Reference gene model
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
58 Gene model in BED format.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
59
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
60 Sampling Percentiles - Upper Bound, Lower Bound, Sampling Increment (defaults= 100, 5, and 5)
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
61 Sampling starts from the Lower Bound and increments to the Upper Bound at the rate of the Sampling Increment.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
62
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
63 Minimum intron length (default=50)
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
64 Minimum intron length (bp).
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
65
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
66 Minimum coverage (default=1)
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
67 Minimum number of supportting reads to call a junction.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
68
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
69 Output
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
70 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
71
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
72 1. output.junctionSaturation_plot.r: R script to generate plot
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
73 2. output.junctionSaturation_plot.pdf
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
74
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
75 .. image:: http://rseqc.sourceforge.net/_images/junction_saturation.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
76 :height: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
77 :width: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
78 :scale: 80 %
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
79
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
80 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).
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
81
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
82
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
83 -----
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
84
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
85 About RSeQC
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
86 +++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
87
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
88 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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
89
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
90 The RSeQC package is licensed under the GNU GPL v3 license.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
91
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
92 .. image:: http://rseqc.sourceforge.net/_static/logo.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
93
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
94 .. _RSeQC: http://rseqc.sourceforge.net/
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
95
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
96
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
97
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
98 </help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
99 </tool>