Mercurial > repos > nilesh > rseqc

annotate junction_annotation.xml @ 63:27e16a30667a draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
author iuc
date Tue, 09 Apr 2024 11:24:55 +0000
parents 473382134e56
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
1 <tool id="rseqc_junction_annotation" name="Junction Annotation" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@GALAXY_VERSION@">
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
2 <description>compares detected splice junctions to reference gene model</description>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
3 <macros>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
4 <import>rseqc_macros.xml</import>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
5 </macros>
61
5968573462fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 8a91236cee4d408ae2b53a3e9b6daebc332d631a
iuc
parents: 60
diff changeset
6 <expand macro="bio_tools"/>
52
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
7 <expand macro="requirements">
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
8 <!--
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
9 Required due to conda solver bug: https://github.com/conda/conda/issues/6269
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
10 See: https://github.com/galaxyproject/tools-iuc/pull/1578 for more info
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
11 -->
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
12 <requirement type="package" version="4.2.2">r-base</requirement>
52
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
13 </expand>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
14 <expand macro="stdio"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
15 <version_command><![CDATA[junction_annotation.py --version]]></version_command>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
16 <command><![CDATA[
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
17 @BAM_SAM_INPUTS@
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
18 junction_annotation.py
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
19 --input-file 'input.${extension}'
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
20 --refgene '${refgene}'
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
21 --out-prefix output
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
22 --min-intron ${min_intron}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
23 --mapq ${mapq}
61
5968573462fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 8a91236cee4d408ae2b53a3e9b6daebc332d631a
iuc
parents: 60
diff changeset
24 2> >(tee -a stats.txt >&2)
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
25 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
26 </command>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
27 <inputs>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
28 <expand macro="bam_sam_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
29 <expand macro="refgene_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
30 <expand macro="min_intron_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
31 <expand macro="mapq_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
32 <expand macro="rscript_output_param"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
33 </inputs>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
34 <outputs>
61
5968573462fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 8a91236cee4d408ae2b53a3e9b6daebc332d631a
iuc
parents: 60
diff changeset
35 <data format="pdf" name="outputpdf" from_work_dir="output.splice_events.pdf" label="${tool.name} on ${on_string}: splice events (PDF)"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
36 <data format="pdf" name="outputjpdf" from_work_dir="output.splice_junction.pdf" label="${tool.name} on ${on_string}: splice junction (PDF)"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
37 <expand macro="xls_output_data" filename="output.junction.xls" label="${tool.name} on ${on_string}: splice junction (XLS)"/>
61
5968573462fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 8a91236cee4d408ae2b53a3e9b6daebc332d631a
iuc
parents: 60
diff changeset
38 <expand macro="rscript_output_data" filename="output.junction_plot.r" label="${tool.name} on ${on_string}: Rscript"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
39 <data format="txt" name="stats" from_work_dir="stats.txt" label="${tool.name} on ${on_string}: stats"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
40 </outputs>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
41 <tests>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
42 <test expect_num_outputs="5">
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
43 <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
59
dbedfc5f5a3c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
iuc
parents: 54
diff changeset
44 <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed" ftype="bed12"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
45 <param name="rscript_output" value="true"/>
62
473382134e56 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit ccb6f7edba5492f4750ef8a59c4f91eb67fdbbec
iuc
parents: 61
diff changeset
46 <output name="outputxls" file="output.junction.xls" ftype="tabular"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
47 <output name="outputr" file="output.junction_plot_r"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
48 <output name="outputpdf" file="output.splice_events.pdf" compare="sim_size"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
49 <output name="outputjpdf" file="output.splice_junction.pdf" compare="sim_size"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
50 <output name="stats" file="output.splice_junction.txt" ftype="txt" lines_diff="2"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
51 </test>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
52 </tests>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
53 <help><![CDATA[
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
54 junction_annotation.py
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
55 ++++++++++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
56
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
57 For a given alignment file (-i) in BAM or SAM format and a reference gene model (-r) in BED
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
58 format, this program will compare detected splice junctions to reference gene model. splicing
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
59 annotation is performed in two levels: splice event level and splice junction level.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
60
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
61 * 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.
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
62 * splice junction: multiple splicing events spanning the same intron can be consolidated into one splicing junction.
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
63
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
64 All detected junctions can be grouped to 3 exclusive categories:
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
65
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
66 1. Annotated: The junction is part of the gene model. Both splice sites, 5' splice site
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
67 (5'SS) and 3'splice site (3'SS) can be annotated by reference gene model.
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
68 2. complete_novel: Complete new junction. Neither of the two splice sites cannot be annotated by gene model
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
69 3. partial_novel: One of the splice site (5'SS or 3'SS) is new, while the other splice site is annotated (known)
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
70
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
71 Inputs
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
72 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
73
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
74 Input BAM/SAM file
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
75 Alignment file in BAM/SAM format.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
76
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
77 Reference gene model
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
78 Gene model in BED format.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
79
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
80 Minimum intron length (default=50)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
81 Minimum intron length (bp).
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
82
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
83
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
84 Output
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
85 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
86
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
87 1. output.junc.anno.junction.xls:
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
88 - chrom ID
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
89 - start position of junction (coordinate is 0 based)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
90 - end position of junction (coordinate is 1 based)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
91 - number of splice events supporting this junction
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
92 - 'annotated', 'complete_novel' or 'partial_novel'.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
93 2. output.anno.junction_plot.r: R script to generate pie chart
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
94 3. output.splice_junction.pdf: plot of splice junctions
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
95 4. output.splice_events.pdf: plot of splice events
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
96
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
97 .. image:: $PATH_TO_IMAGES/junction.png
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
98 :height: 400 px
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
99 :width: 850 px
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
100 :scale: 80 %
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
101
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
102 @ABOUT@
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
103
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
104 ]]>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
105 </help>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 62
diff changeset
106 <expand macro="citations"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
107 </tool>