annotate crossmap_gff.xml @ 15:75a08e10cc76 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit ad4d739b4837dd61abc85614568d22f271f14568
author iuc
date Mon, 02 Sep 2024 12:02:06 +0000
parents 4d97434ea0fb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
4d97434ea0fb "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit f436317e2f8d451621e297cfc474e43c20d60bb7"
iuc
parents: 9
diff changeset
1 <tool id="crossmap_gff" name="CrossMap GFF" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="20.05">
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 <command><![CDATA[
15
75a08e10cc76 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit ad4d739b4837dd61abc85614568d22f271f14568
iuc
parents: 13
diff changeset
10 CrossMap gff
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
11 '${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
12 '${input}'
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
13
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
14 #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
15 >
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
16 #end if
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
17
9
040eed862c91 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit 23fab16cd40acbd5b0e9d640ed3858040db7a622
iuc
parents: 8
diff changeset
18 output
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
19 ]]></command>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
20 <inputs>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
21 <param name="input" type="data" format="gtf,gff,gff3" label="GTF/GFF file"/>
15
75a08e10cc76 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit ad4d739b4837dd61abc85614568d22f271f14568
iuc
parents: 13
diff changeset
22 <expand macro="chain"/>
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="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
24 </inputs>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
25 <outputs>
15
75a08e10cc76 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit ad4d739b4837dd61abc85614568d22f271f14568
iuc
parents: 13
diff changeset
26 <data name="output" format="gff" label="${tool.name} on ${on_string}" from_work_dir="output"/>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
27 </outputs>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
28 <tests>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
29 <test>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
30 <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
31 <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
32 <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
33 <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
34 <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
35 </test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
36 <test>
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
37 <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
38 <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
39 <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
40 <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
41 <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
42 </test>
15
75a08e10cc76 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit ad4d739b4837dd61abc85614568d22f271f14568
iuc
parents: 13
diff changeset
43 <test>
75a08e10cc76 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit ad4d739b4837dd61abc85614568d22f271f14568
iuc
parents: 13
diff changeset
44 <!-- cached chain file -->
8
45c57bf42470 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit 39a5f30a013c6d71ea84807b72511e3aa4bab147
iuc
parents: 7
diff changeset
45 <param name="input" value="test_gff_01_input_a.gtf" ftype="gtf" dbkey="hg18"/>
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="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
47 <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
48 <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
49 </test>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
50 </tests>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
51 <help><![CDATA[
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
52 @HELP_GENERAL@
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
53
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
54 GFF / GTF
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 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
57
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
58 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
59 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
60 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
61 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
62
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
63 Notes:
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
64
7
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
65 - 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
66 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
67 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
68 - If user want to liftover gene annotation files, use BED12 format.
1b57bf1bb4ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit e365f2835488e73b870c73502c24ff23d28b76a5
iuc
parents: 0
diff changeset
69 ]]></help>
0
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
70 <citations>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
71 <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
72 </citations>
5773a57e91e6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/crossmap commit d578fad97ce545d68dde40155d36426a121e4447
iuc
parents:
diff changeset
73 </tool>