annotate mafFetch.xml @ 1:3b8eea04d99d draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit fe43201294560762b7aab73785df2f1f7828cb9e
author iuc
date Thu, 14 Aug 2025 11:59:08 +0000
parents eb31f147bf4a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
1 <tool id="ucsc_maffetch" name="mafFetch" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@" license="MIT">
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
2 <description>Get overlapping records from an MAF using an index table</description>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
3 <macros>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
4 <token name="@TOOL_VERSION@">482</token>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
6 <token name="@PROFILE@">24.2</token>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
7 </macros>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
8 <requirements>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
9 <requirement type="package" version="@TOOL_VERSION@">ucsc-maffetch</requirement>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
10 </requirements>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
11 <command detect_errors="exit_code">
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
12 <![CDATA[
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
13 cp '$ucsc_db_connection' "\${HOME}/.hg.conf" &&
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
14 chmod 600 "\${HOME}/.hg.conf" &&
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
15 mafFetch '$genome' '$track' '$bed_file' out.maf
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
16 ]]>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
17 </command>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
18 <configfiles>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
19 <configfile name="ucsc_db_connection"><![CDATA[
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
20 #European MariaDB server
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
21 db.host=genome-euro-mysql.soe.ucsc.edu
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
22 db.user=genomep
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
23 db.password=password
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
24 central.db=hgcentral
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
25 central.host=genome-euro-mysql.soe.ucsc.edu
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
26 central.user=genomep
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
27 central.password=password
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
28 gbdbLoc1=http://hgdownload.soe.ucsc.edu/gbdb/
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
29 forceTwoBit=on
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
30 ]]></configfile>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
31 </configfiles>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
32 <inputs>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
33 <param name="bed_file" type="data" format="bed" label="Input BED file" help="Input BED file can be either BED6 or BED12"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
34 <param name="genome" type="text" optional="false" label="Enter Genome database name" help="Name should match with the UCSC Table Browser Entries (For Eg. mm10, hg19, hg38)"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
35 <param name="track" type="text" optional="false" label="Enter UCSC Table name for desired table of the above genome" help="Table name should match with the UCSC Table Browser Entries (For eg. knownGene, all_mrna)"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
36 </inputs>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
37 <outputs>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
38 <data name="output" format="maf" from_work_dir="out.maf" label="${tool.name} on ${on_string}:Output MAF"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
39 </outputs>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
40 <tests>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
41 <!-- Test 01: Testing with default options -->
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
42 <test expect_num_outputs="1">
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
43 <param name="bed_file" value="mafFetch.bed"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
44 <param name="genome" value="hg19"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
45 <param name="track" value="multiz46way"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
46 <output name="output" ftype="maf">
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
47 <assert_contents>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
48 <has_n_lines n="167"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
49 <has_size value="17364"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
50 </assert_contents>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
51 </output>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
52 </test>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
53 </tests>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
54 <help><![CDATA[
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
55
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
56 mafFetch is a command-line tool from the UCSC Genome Browser suite that extracts MAF records overlapping regions in a BED file (minimum 3 columns: chrom, start, end) from a specified UCSC database table (e.g., multiz46way for hg19). Outputs alignments to a MAF file using an indexed lookup for efficiency.
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
57
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
58 ]]></help>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
59 <citations>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
60 <citation type="bibtex">
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
61 @misc{mafFetch,
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
62 author = {Kent UCSC},
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
63 title = {mafFetch: A tool for get overlapping records from an MAF using an index table},
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
64 note = {Tool for get overlapping records from an MAF using an index table}
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
65 </citation>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
66 </citations>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
67 <creator>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
68 <person givenName="Saim" familyName="Momin" url="https://github.com/SaimMomin12" identifier="https://orcid.org/0009-0003-9935-828X"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
69 <organization name="Galaxy Europe" url="https://galaxyproject.org/eu/"/>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
70 </creator>
eb31f147bf4a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ucsc_tools/maftools commit b4d87499a5677fbf611eedfa06c1b3d5cdc23914
iuc
parents:
diff changeset
71 </tool>