annotate gff3_rebase.xml @ 0:e54940ea270c draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
author iuc
date Thu, 20 Apr 2017 08:12:49 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
1 <tool id="gff3.rebase" name="Rebase GFF3 features" version="1.2">
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
2 <description>against parent features</description>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
3 <macros>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
4 <import>macros.xml</import>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
5 </macros>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
7 <version_command>python gff3_rebase.py --version</version_command>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
9 python '$__tool_directory__/gff3_rebase.py'
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
10 '$parent'
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
11 '$child'
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
12
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
13 $interpro
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
14 $protein2dna
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
15 > '$output']]>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
16 </command>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
17 <inputs>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
18 <param label="Parent GFF3 annotations" name="parent" format="gff3" type="data"/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
19 <param label="Child GFF3 annotations to rebase against parent" name="child" format="gff3" type="data"/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
20
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
21 <param label="Interpro specific modifications" name="interpro" type="boolean" truevalue="--interpro" falsevalue=""/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
22 <param label="Map protein translated results to original DNA data" name="protein2dna" type="boolean" truevalue="--protein2dna" falsevalue=""/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
23 </inputs>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
24 <outputs>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
25 <data format="gff3" name="output"/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
26 </outputs>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
27 <tests>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
28 <test>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
29 <param name="parent" value="parent.gff"/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
30 <param name="child" value="child.gff"/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
31 <param name="protein2dna" value="True" />
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
32 <output name="output" file="proteins.gff"/>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
33 </test>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
34 </tests>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
35 <help><![CDATA[
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
36 **What it does**
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
37
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
38 Often the genomic data processing/analysis process requires a workflow like the following:
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
39
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
40 - select some features from a genome
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
41 - export the sequences associated with those regions
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
42 - analyse those exports with some tool like Blast
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
43
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
44 For display, especially in software like JBrowse, it is convenient to know
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
45 where in the original genome the analysis results would fall. E.g. if a
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
46 transmembrane domain is detected at bases 10-20 of an analysed protein, where
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
47 should this be displayed relative to the parent genome?
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
48
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
49 This tool helps fill that gap, by rebasing some analysis results against the
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
50 parent features which were originally analysed.
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
51
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
52 **Example Inputs**
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
53
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
54 For a "child" set of annotations like::
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
55
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
56 #gff-version 3
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
57 cds42 blastp match_part 1 50 1e-40 . . ID=m00001;Notes=RNAse A Protein
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
58
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
59 And a parent set of annotations like::
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
60
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
61 #gff-version 3
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
62 PhageBob maker cds 300 600 . + . ID=cds42
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
63
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
64 One could imagine that during the analysis process, the user had exported the parent annotation into some sequence::
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
65
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
66 >cds42
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
67 M......
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
68
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
69 and then analysed those results, producing the "child" annotation file. This
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
70 tool will then localize the results properly against the parent::
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
71
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
72 #gff-version 3
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
73 PhageBob blastp match_part 300 449 1e-40 + . ID=m00001;Notes=RNAse A Protein
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
74
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
75 which will allow you to display the results in the correct location in visualizations.
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
76
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
77 **Options**
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
78
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
79 There are two optional flags which can be passed.
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
80
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
81 The Interpro flag selectively ignores features which shouldn't be included in
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
82 the output (i.e. ``polypeptide``), and a couple of qualifiers that aren't
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
83 useful (``status``, ``Target``)
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
84
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
85 The "Map Protein..." flag says that you translated the sequences during the
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
86 genomic export process, analysing protein sequences. This indicates to the
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
87 software that the bases should be multiplied by three to obtain the correct DNA
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
88 locations.
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
89 ]]></help>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
90 <citations>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
91 <citation type="doi">10.1093/bioinformatics/btp163</citation>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
92 </citations>
e54940ea270c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gff3_rebase commit 350ab347625ed5941873ba0deb3e1cf219d60052
iuc
parents:
diff changeset
93 </tool>