annotate crossmap_gff.xml @ 6:9ca13f08f2f7 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447-dirty
author iuc
date Tue, 26 Sep 2017 06:09:26 -0400
parents 5773a57e91e6
children 1b57bf1bb4ec
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[
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
11 CrossMap.py gff
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
12 '${chain_source.input_chain}'
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
13 '${seq_source.input}'
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
14
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
15 #if str($include_fails) == "True"
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
16 >
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
17 #end if
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
18
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
19 '${output}'
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>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
23 <conditional name="seq_source">
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
24 <expand macro="source" />
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
25
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
26 <when value="cached">
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
27 <param format="gtf,gff,gff3" name="input" type="data" label="GTF/GFF file">
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
28 <validator type="unspecified_build"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
29 <!-- Gives error in tests
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
30 <validator type="dataset_metadata_in_file" filename="liftOver.loc" metadata_name="dbkey" metadata_column="0" message="LiftOver mapping (chain file) is not available for the specified build."/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
31 -->
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
32 </param>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
33 </when>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
34 <when value="history">
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
35 <param type="data" format="gtf,gff,gff3" name="input" label="GTF/GFF file"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
36 </when>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
37 </conditional>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
38 <expand macro="chain" />
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
39
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
40 <param name="include_fails" type="boolean" truevalue="True" checked="false" 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')"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
41 </inputs>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
42
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
43 <outputs>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
44 <!-- GTF/GFF3? test... -->
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
45 <data format="gff" name="output" label="${tool.name} on ${on_string}" />
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
46 </outputs>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
47
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
48 <tests>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
49 <!-- GFF -->
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
50 <test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
51 <param name="input_format" value="gff"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
52 <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
53 <param name="input" value="test_gff_01_input_a.gtf" ftype="gtf"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
54 <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
55 <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
56
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
57 <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
58 </test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
59 <test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
60 <param name="input_format" value="gff"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
61 <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
62 <param name="input" value="test_gff_01_input_a.gtf" ftype="gtf"/>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
63 <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
64 <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
65
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
66 <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
67 </test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
68 </tests>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
69 <help><![CDATA[
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
70 @HELP_GENERAL@
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
71
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
72 GFF / GTF
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
73 ---------
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
74 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
75
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
76 GFF (General Feature Format) is another plain text file used to describe
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
77 gene structure. GTF (Gene Transfer Format) is a refined version of GTF. The
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
78 first eight fields are the same as GFF. Only chromosome and genome
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
79 coordinates are updated. The format of output is determined from the input.
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
80
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
81 NOTE:
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
82
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
83 - Each feature (exon, intron, UTR, etc) is processed separately and
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
84 independently, and we do NOT check if features originally belonging to
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
85 the same gene were converted into the same gene.
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
86 - If user want to liftover gene annotation files, use BED12 format.
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
87
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
88 Please see `the manual <http://crossmap.sourceforge.net/#convert-gff-gtf-format-files>`__ for more details
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
89 ]]></help>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
90
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
91 <citations>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
92 <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
93 </citations>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
94 </tool>