annotate maftoaxt.xml @ 1:df00da62178e draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
author iuc
date Sun, 22 Sep 2024 07:24:57 +0000
parents d1f6d417813d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
1 <tool id="maftoaxt" name="mafToAxt" version="@TOOL_VERSION@+galaxy0" profile="21.05" license="MIT">
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
2 <description>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
3 Convert file from MAF to axt format
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
4 </description>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
5 <macros>
1
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
6 <token name="@TOOL_VERSION@">469</token>
0
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
7 </macros>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
8 <xrefs>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
9 <xref type="bio.tools">UCSC_Genome_Browser_Utilities</xref>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
10 </xrefs>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
11 <requirements>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
12 <requirement type="package" version="@TOOL_VERSION@">ucsc-maftoaxt</requirement>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
13 </requirements>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
14 <version_command><![CDATA[ echo "@TOOL_VERSION@" ]]></version_command>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
15 <command detect_errors="exit_code"><![CDATA[
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
16 mafToAxt
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
17 '$in_maf'
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
18 #if $tar_seq.tarSeq == "customTar"
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
19 '$tar_seq.targetSeq'
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
20 #else
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
21 first
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
22 #end if
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
23 '$querySeq'
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
24 '$out'
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
25 $stripDb
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
26 ]]></command>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
27 <inputs>
1
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
28 <param name="in_maf" format="maf" type="data" label="MAF dataset" />
0
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
29
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
30 <conditional name="tar_seq">
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
31 <param name="tarSeq" type="select" label="Select target sequence" optional="false" help="Which sequence from the MAF file should be used as the target sequence. ">
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
32 <option value="" selected="true">Use the first sequence of the block as the target</option>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
33 <option value="customTar">Specify the target sequence by name</option>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
34 </param>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
35 <when value="customTar">
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
36 <param optional="false" name="targetSeq" type="text" label="Name of sequence that should be used as target sequence" help="Must be present in the MAF file." />
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
37 </when>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
38 <when value="" />
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
39 </conditional>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
40
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
41 <param name="querySeq" type="text" optional="false" label="Name of sequence that should be used as the query sequence" help="Must be present in the MAF file." />
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
42 <param argument="-stripDb" type="boolean" truevalue="-stripDb" falsevalue="" label="Strip names from start to the first period" help="'hg38.chr19' becomes 'chr19'" />
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
43
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
44 </inputs>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
45 <outputs>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
46 <data name="out" format="axt" />
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
47 </outputs>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
48 <tests>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
49 <test>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
50 <param name="in_maf" value="1.maf"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
51 <param name="querySeq" value="panTro1"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
52 <output name="out" file="1.axt"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
53 </test>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
54 <test>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
55 <param name="in_maf" value="1.maf"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
56 <param name="tarSeq" value="customTar"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
57 <param name="targetSeq" value="panTro1"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
58 <param name="querySeq" value="rn3"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
59 <output name="out" file="2.axt"/>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
60 </test>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
61 </tests>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
62 <help><![CDATA[
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
63 **What it does**
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
64
1
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
65 `mafToAxt`_ is a tool to convert `MAF`_ dataset to `axt`_ format. Depending on parameters and the number of alignments in the MAF file this can be a full conversion or data extraction.
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
66
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
67 For implementation details see mafToAxt's `source code`_.
0
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
68
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
69 .. _mafToAxt: http://hgdownload.cse.ucsc.edu/admin/exe/linux.x86_64/FOOTER.txt
1
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
70 .. _axt: https://genome.ucsc.edu/goldenPath/help/axt.html
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
71 .. _MAF: https://genome.ucsc.edu/FAQ/FAQformat.html#format5
df00da62178e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftoaxt commit 303002db06287fb25306020c4391626842f52162
iuc
parents: 0
diff changeset
72 .. _source code: https://github.com/ucscGenomeBrowser/kent/blob/master/src/hg/mouseStuff/mafToAxt/mafToAxt.c
0
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
73 ]]> </help>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
74 <citations>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
75 <citation type="doi">10.1093/bib/bbs038</citation>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
76 </citations>
d1f6d417813d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ucsc-tools/maftoaxt commit f12613ba8034a78d45054ec07a7cd6853dbb62aa
iuc
parents:
diff changeset
77 </tool>