annotate crossmap_gff.xml @ 7:1b57bf1bb4ec draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
author iuc
date Fri, 20 Oct 2017 02:48:09 -0400
parents 5773a57e91e6
children 45c57bf42470
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
1 <tool id="crossmap_gff" name="CrossMap GFF" version="@WRAPPER_VERSION@-0">
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
2 <description>Convert genome coordinates or annotation files between genome assemblies</description>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
3 <macros>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
4 <import>macros.xml</import>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
5 </macros>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
7 <expand macro="stdio"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
8 <expand macro="version_command"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
9
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
10 <command><![CDATA[
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
11 CrossMap.py gff
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
12 '${chain_source.input_chain}'
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
13 '${input}'
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
14
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
15 #if str($include_fails) == "True"
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
16 >
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
17 #end if
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
18
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
19 '${output}'
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
20 ]]></command>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
21
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
22 <inputs>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
23 <param name="input" type="data" format="gtf,gff,gff3" label="GTF/GFF file"/>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
24
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
25 <expand macro="chain" />
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
26
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
27 <param name="include_fails" type="boolean" truevalue="True" falsevalue="False" label="Include failed liftovers" help="If a coordinate can not be lift over, do you want to include it in the output (it is still being marked 'fail')"/>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
28 </inputs>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
29
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
30 <outputs>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
31 <data name="output" format="gff" label="${tool.name} on ${on_string}" />
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
32 </outputs>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
33
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
34 <tests>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
35 <test>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
36 <param name="input" value="test_gff_01_input_a.gtf" ftype="gtf"/>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
37 <param name="index_source" value="history"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
38 <param name="input_chain" value="aToB.over.chain" ftype="csv"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
39 <param name="include_fails" value="False"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
40
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
41 <output name="output" file="test_gff_01_output_a__only-matches.gtf"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
42 </test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
43 <test>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
44 <param name="input" value="test_gff_01_input_a.gtf" ftype="gtf"/>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
45 <param name="index_source" value="history"/>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
46 <param name="input_chain" value="aToB.over.chain" ftype="csv"/>
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
47 <param name="include_fails" value="True"/>
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
48
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
49 <output name="output" file="test_gff_01_output_a__all.gtf"/>
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
50 </test>
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
51 <test><!-- cached chain file -->
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
52 <param name="input" value="test_gff_01_input_a.gtf" ftype="gtf"/>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
53 <param name="index_source" value="cached"/>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
54 <param name="include_fails" value="True"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
55
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
56 <output name="output" file="test_gff_01_output_a__all.gtf"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
57 </test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
58 </tests>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
59 <help><![CDATA[
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
60 @HELP_GENERAL@
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
61
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
62 GFF / GTF
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
63 ---------
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
64 Your input data should be either GTF/GFF2.5 or GFF3 format.
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
65
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
66 GFF (General Feature Format) is another plain text file used to describe
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
67 gene structure. GTF (Gene Transfer Format) is a refined version of GTF. The
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
68 first eight fields are the same as GFF. Only chromosome and genome
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
69 coordinates are updated. The format of output is determined from the input.
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
70
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
71 Notes:
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
72
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
73 - Each feature (exon, intron, UTR, etc) is processed separately and
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
74 independently, and we do NOT check if features originally belonging to
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
75 the same gene were converted into the same gene.
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
76 - If user want to liftover gene annotation files, use BED12 format.
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
77
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
78 ]]></help>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
79
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
80 <citations>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
81 <citation type="doi">10.1093/bioinformatics/btt730</citation>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
82 </citations>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
83 </tool>