Mercurial > repos > nilesh > rseqc

annotate junction_annotation.xml @ 43:378d05d35705 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author lparsons
date Wed, 23 Jul 2014 10:58:28 -0400
parents 1e66f05a23aa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
40
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
1 <tool id="rseqc_junction_annotation" name="Junction Annotation" version="2.3.9">
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
2 <description>compares detected splice junctions to reference gene model</description>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
3 <requirements>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
4 <requirement type="package" version="3.0.1">R</requirement>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.3.9">rseqc</requirement>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
7 </requirements>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
8 <command>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
9 junction_annotation.py
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
10 -i $input -o output -r $refgene
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
11 #if $intron.hasIntron
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
12 -m $intron.min_Intron
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
13 #end if
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
14 </command>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
15 <stdio>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
16 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
17 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
18 </stdio>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
19 <inputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
20 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
21 <param name="refgene" type="data" format="bed" label="reference gene model" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
22 <conditional name="intron">
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
23 <param name="hasIntron" type="boolean" label="Specify minimum intron length" value="false"/>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
24 <when value="true">
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
25 <param name="min_Intron" type="integer" value="50" label="Minimum intron length (bp, default=50)" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
26 </when>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
27 </conditional>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
28 </inputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
29 <outputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
30 <data format="xls" name="outputxls" from_work_dir="output.junction.xls" label="${tool.name} on ${on_string} (XLS)"/>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
31 <data format="txt" name="outputr" from_work_dir="output.junction_plot.r" label="${tool.name} on ${on_string} (R Script)" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
32 <data format="pdf" name="outputpdf" from_work_dir="output.splice_events.pdf" label="${tool.name} on ${on_string} (Splice Events PDF)"/>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
33 <data format="pdf" name="outputjpdf" from_work_dir="output.splice_junction.pdf" label="${tool.name} on ${on_string} (Splice Junction PDF)" />
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
34 </outputs>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
35 <help>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
36 junction_annotation.py
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
37 ++++++++++++++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
38
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
39 For a given alignment file (-i) in BAM or SAM format and a reference gene model (-r) in BED
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
40 format, this program will compare detected splice junctions to reference gene model. splicing
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
41 annotation is performed in two levels: splice event level and splice junction level.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
42
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
43 * splice event: An RNA read, especially long read, can be spliced 2 or more times, each time is called a splicing event; In this sense, 100 spliced reads can produce >= 100 splicing events.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
44 * splice junction: multiple splicing events spanning the same intron can be consolidated into one splicing junction.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
45
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
46 All detected junctions can be grouped to 3 exclusive categories:
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
47
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
48 1. Annotated: The junction is part of the gene model. Both splice sites, 5' splice site
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
49 (5'SS) and 3'splice site (3'SS) can be annotated by reference gene model.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
50 2. complete_novel: Complete new junction. Neither of the two splice sites cannot be annotated by gene model
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
51 3. partial_novel: One of the splice site (5'SS or 3'SS) is new, while the other splice site is annotated (known)
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
52
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
53 Inputs
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
54 ++++++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
55
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
56 Input BAM/SAM file
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
57 Alignment file in BAM/SAM format.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
58
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
59 Reference gene model
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
60 Gene model in BED format.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
61
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
62 Minimum intron length (default=50)
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
63 Minimum intron length (bp).
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
64
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
65
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
66 Output
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
67 ++++++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
68
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
69 1. output.junc.anno.junction.xls:
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
70 - chrom ID
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
71 - start position of junction (coordinate is 0 based)
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
72 - end position of junction (coordinate is 1 based)
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
73 - number of splice events supporting this junction
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
74 - 'annotated', 'complete_novel' or 'partial_novel'.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
75 2. output.anno.junction_plot.r: R script to generate pie chart
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
76 3. output.splice_junction.pdf: plot of splice junctions
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
77 4. output.splice_events.pdf: plot of splice events
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
78
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
79 .. image:: http://rseqc.sourceforge.net/_images/junction.png
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
80 :height: 400 px
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
81 :width: 850 px
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
82 :scale: 80 %
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
83
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
84 -----
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
85
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
86 About RSeQC
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
87 +++++++++++
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
88
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
89 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.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
90
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
91 The RSeQC package is licensed under the GNU GPL v3 license.
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
92
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
93 .. image:: http://rseqc.sourceforge.net/_static/logo.png
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
94
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
95 .. _RSeQC: http://rseqc.sourceforge.net/
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
96
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
97
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
98
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
99
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
100 </help>
1e66f05a23aa Reupload tarball (all files were again deleted by toolshed).
lparsons
parents:
diff changeset
101 </tool>