annotate circexplorer.xml @ 3:0c08f1685640 draft default tip

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a3232e388d52097083f2662ccb26351fdc2f2412-dirty
author bgruening
date Tue, 07 Jun 2016 17:43:16 -0400
parents 614498559b5e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
0c08f1685640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a3232e388d52097083f2662ccb26351fdc2f2412-dirty
bgruening
parents: 2
diff changeset
1 <tool id="circexplorer" name="CIRCexplorer" version="1.1.9.0">
0
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
2 <requirements>
3
0c08f1685640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a3232e388d52097083f2662ccb26351fdc2f2412-dirty
bgruening
parents: 2
diff changeset
3 <requirement type="package" version="1.1.9">circexplorer</requirement>
0
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
4 </requirements>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
5 <command><![CDATA[
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
6 #if str($input_selection.input_type) == "star"
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
7 star_parse.py "$input_selection.junc" ./fusion_junctions.txt &&
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
8 #end if
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
9
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
10 CIRCexplorer.py
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
11
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
12 #if str($input_selection.input_type) == "tophat"
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
13 -f "$input_selection.fusion"
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
14 #elif str($input_selection.input_type) == "star"
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
15 -j ./fusion_junctions.txt
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
16 #end if
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
17
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
18 -g "$genome"
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
19 -r "$ref"
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
20 $no_fix
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
21 ]]>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
22 </command>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
23 <inputs>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
24 <conditional name="input_selection">
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
25 <param name="input_type" type="select" label="Select input type" help="">
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
26 <option value="tophat">TopHat &amp; TopHat-Fusion</option>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
27 <option value="star">STAR</option>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
28 </param>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
29 <when value="tophat">
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
30 <param argument="--fusion" type="data" format="bam" label="TopHat-Fusion fusion BAM file (used in TopHat-Fusion mapping)" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
31 </when>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
32 <when value="star">
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
33 <param argument="--junc" type="data" format="bam" label="STAR Chimeric junction file (used in STAR mapping)" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
34 </when>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
35 </conditional>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
36
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
37 <param argument="--genome" type="data" format="fasta" label="Genome FASTA file" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
38
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
39 <param argument="--ref" type="data" format="txt" label="Gene annotation" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
40
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
41 <param name="no_fix" type="boolean" checked="false" truevalue="--no-fix" falsevalue=""
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
42 label="No-fix mode (useful for species with poor gene annotations)" help="(--no-fix)" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
43 </inputs>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
44 <outputs>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
45 <data name="output" format="txt"/>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
46 </outputs>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
47 <tests>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
48 <test>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
49 <param name="input_type" value="tophat" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
50 <param name="fusion" value="circ_tophat.bam" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
51 <param name="genome" value="circ_genome.fasta" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
52 <param name="ref" value="circ_ref.txt" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
53 <output name="output" file="circ_output.txt" ftype="txt"/>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
54 </test>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
55 <test>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
56 <param name="input_type" value="star" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
57 <param name="junc" value="circ_Chimeric.out.junction" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
58 <param name="genome" value="circ_genome.fasta" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
59 <param name="ref" value="circ_ref.txt" />
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
60 <output name="output" file="circ_output.txt" ftype="txt"/>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
61 </test>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
62 </tests>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
63 <help>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
64 **What it does**
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
65
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
66 `CIRCexplorer`_ is a combined strategy to identify junction reads from back spliced exons and intron lariats.
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
67
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
68 **A schematic flow shows the pipeline**
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
69
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
70 .. image:: $PATH_TO_IMAGES/flow.jpg
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
71
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
72 .. _CIRCexplorer: https://github.com/YangLab/CIRCexplorer
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
73
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
74 **Notice**
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
75
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
76 CIRCexplorer is now only a circular RNA annotating tool and it parses fusion junction information from mapping results of other aligners. The result of circular RNA annotating directly depends on the mapping strategy of aligners. Different aligners may have different circular RNA annotations. CIRCexplorer is now only in charge of giving fusion junctions a correct gene annotation. Other functions and supports for more aligners are under development.
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
77 </help>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
78 <citations>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
79 <citation type="bibtex">
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
80 @article{Cell,
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
81 author = {Zhang XO, Wang HB, Zhang Y, Lu X, Chen LL and Yang L},
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
82 year = {2014},
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
83 title = {Complementary Sequence-Mediated Exon Circularization},
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
84 publisher = {Cell},
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
85 journal = {Cell},
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
86 url = {http://www.cell.com/cell/abstract/S0092-8674(14)01111-8},
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
87 }
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
88 </citation>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
89 </citations>
7858d4fd5ff3 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/circexplorer commit a35817eb4119e6d674d01a5f7f91d4cddd0155d1
bgruening
parents:
diff changeset
90 </tool>