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