annotate extract_metaphlan_database.xml @ 10:39180ac12d65 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/metaphlan commit 26cbf16569d13b7ddbbbd99fc49ec15ce312a992
author iuc
date Fri, 14 Nov 2025 13:46:43 +0000
parents b81c6e597cf1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
1 <tool id="extract_metaphlan_database" name="Extract the marker sequences and metadata" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
2 <description>from the MetaPhlAn database</description>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
3 <macros>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
5 </macros>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
6 <expand macro="edam_ontology"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
8 <version_command>metaphlan -v</version_command>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
9 <command detect_errors="aggressive"><![CDATA[
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
10 bowtie2-inspect
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
11 '${cached_db.fields.path}/${cached_db.fields.dbkey}'
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
12 > '$sequences'
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
13
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
14 &&
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
15
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
16 python '$__tool_directory__/customizemetadata.py'
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
17 transform_pkl_to_json
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
18 --pkl '${cached_db.fields.path}/${cached_db.fields.dbkey}.pkl'
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
19 --json '$metadata'
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
20 ]]></command>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
21 <inputs>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
22 <param name="cached_db" label="Cached database with clade-specific marker genes" type="select">
5
b81c6e597cf1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 08ec37116aab4268fdb93f175b60e50a0bbfafb2
iuc
parents: 0
diff changeset
23 <options from_data_table="@IDX_DATA_TABLE@">
b81c6e597cf1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 08ec37116aab4268fdb93f175b60e50a0bbfafb2
iuc
parents: 0
diff changeset
24 <filter type="static_value" column="4" value="@IDX_VERSION@"/>
b81c6e597cf1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 08ec37116aab4268fdb93f175b60e50a0bbfafb2
iuc
parents: 0
diff changeset
25 <validator message="No MetaPhlAn database is available" type="no_options"/>
0
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
26 </options>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
27 </param>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
28 </inputs>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
29 <outputs>
5
b81c6e597cf1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 08ec37116aab4268fdb93f175b60e50a0bbfafb2
iuc
parents: 0
diff changeset
30 <data name="sequences" format="fasta" label="${tool.name} on ${on_string}: Marker seqeunces from MetaPhlAn database"/>
b81c6e597cf1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 08ec37116aab4268fdb93f175b60e50a0bbfafb2
iuc
parents: 0
diff changeset
31 <data name="metadata" format="json" label="${tool.name} on ${on_string}: Marker metadata from MetaPhlAn database"/>
0
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
32 </outputs>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
33 <tests>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
34 <test expect_num_outputs="2">
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
35 <param name="cached_db" value="test-db-20210409"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
36 <output name="sequences" file="test-db.fasta" ftype="fasta" compare="sim_size">
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
37 <assert_contents>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
38 <has_line line=">13076__A0A2I1PE66__CYJ72_10760 UniRef90_A0A2I1PE66;k__Bacteria|p__Firmicutes|c__Bacilli|o__Lactobacillales|f__Aerococcaceae|g__Globicatella|s__Globicatella_sanguinis;GCA_002847845"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
39 </assert_contents>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
40 </output>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
41 <output name="metadata" file="test-db.json" ftype="json" compare="sim_size">
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
42 <assert_contents>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
43 <has_text text="13076__A0A2I1PE66__CYJ72_10760"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
44 <has_text text="k__Bacteria|p__Firmicutes|c__Bacilli|o__Lactobacillales|f__Aerococcaceae|g__Globicatella|s__Globicatella_sanguinis"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
45 <has_text text="GCA_002847845"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
46 <has_text text="clade"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
47 <has_text text="ext"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
48 <has_text text="len"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
49 <has_text text="taxon"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
50 <has_text text="markers"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
51 <has_text text="taxonomy"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
52 <has_text text="merged_taxon"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
53 </assert_contents>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
54 </output>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
55 </test>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
56 </tests>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
57 <help><![CDATA[
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
58 What it does
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
59 ============
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
60
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
61 Reconstruct the marker sequences (in fasta format) and metadata (in JSON) from the MetaPhlAn BowTie2 database
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
62
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
63 Outputs
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
64 =======
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
65
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
66 - Fasta file with marker sequences.
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
67
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
68 This file can be used to add new marker sequences and then customizing the database.
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
69
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
70 - JSON file with marker metadata
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
71
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
72 ]]></help>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
73 <expand macro="citations"/>
3230167ebbc0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/metaphlan/ commit 1e543a44ceffd8e4c5537b9015606ab3b90a114c"
iuc
parents:
diff changeset
74 </tool>