Mercurial > repos > iuc > biobox_add_taxid

comparison biobox_add_taxid.xml @ 0:1e10251b9615 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/amber/ commit 91090b1565baeddbd3c96e74bc08a37990fafd3a
author iuc
date Sun, 25 Aug 2024 13:19:14 +0000
parents
children 450a61fc097f
comparison
equal deleted inserted replaced
-1:000000000000 0:1e10251b9615
1 <tool id="biobox_add_taxid" name="Biobox add taxid" version="@SCRIPT_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
2 <description>Add taxid output from BAT or GTDB to biobox binning data</description>
3 <macros>
4 <import>macros.xml</import>
5 <token name="@SCRIPT_VERSION@">0.4</token>
6 </macros>
7 <requirements>
8 <requirement type="package" version="@SCRIPT_VERSION@">biobox_add_taxid</requirement>
9 </requirements>
10 <command detect_errors="exit_code">
11 <![CDATA[
12
13 mkdir -p input &&
14
15 ln -s '${biobox_file}' '$biobox_file.element_identifier' &&
16
17 #for $i, $f in enumerate($tool_type.input):
18 ln -s '$f' 'input/${i}.tsv' &&
19 #end for
20
21 biobox_add_taxid.py
22 '$biobox_file.element_identifier'
23 '$tool_type.is_select'
24 'input'
25 #if $tool_type.is_select == 'GTDB':
26 -g '$gtdb_to_taxdump'
27 -t '$taxonkit'
28 -c $column
29 #end if
30 &&
31
32 #if $tool_type.is_select == 'GTDB':
33 cp *_add_taxid_GTDB* $output
34 #else:
35 cp *_add_taxid_BAT* $output
36 #end if
37
38 ]]>
39 </command>
40 <inputs>
41 <param name="biobox_file" type="data" format="tabular" label="CAMI amber biobox file input" help="Input the CAMI amber biobox file here which are corespond with the biner and the BAT/GTDB output which did used the biner as input! "/>
42 <conditional name="tool_type">
43 <param name="is_select" type="select" label="Select the tool which output should be used here" help="Select BAT when you use the bin2classifier file(s) or select GTDB when using the summary file(s)">
44 <option value="BAT">BAT</option>
45 <option value="GTDB">GTDB</option>
46 </param>
47 <when value="GTDB">
48 <param argument="--gtdb_to_taxdump" type="data" format="tabular" label="Input the output from gtdb_to_taxdump here" help="Use the output from gtdb_to_taxdump here since we need the mapped names from GTDB to NCBI to get the arcoding taxids from NCBI"/>
49 <param argument="--taxonkit" type="data" format="tabular" label="Input the output from Taxonkit here" help="Use the output from Taxonkit here since the need the mapped NCBI names to the arcording taxids"/>
50 <param argument="--column" type="data_column" data_ref="taxonkit" label="Input the colum with the NCBI names"/>
51 <param name="input" type="data" multiple="true" format="tabular" label="Input the GTDB-Tk summary file(s) here"
52 help="Use the GTDB-Tk file(s) which are coresponding with the binning file!"/>
53 </when>
54 <when value="BAT">
55 <param name="input" type="data" multiple="true" format="tabular" label="Input bin2classifier file(s) from BAT here"
56 help="Use the BAT file(s) which are coresponding with the binning file!"/>
57 </when>
58 </conditional>
59 </inputs>
60 <outputs>
61 <data name="output" format="tabular" label="${tool.name}: BIOBOX ADD TAXID COLUMN"/>
62 </outputs>
63 <tests>
64 <test expect_num_outputs="1">
65 <param name="biobox_file" ftype="tabular" value="test_biobox_file.tsv"/>
66 <conditional name="tool_type">
67 <param name="is_select" value="BAT"/>
68 <param name="input" ftype="tabular" value="test_bat_file.tsv"/>
69 </conditional>
70 <output name="output" file="test_biobox_file_add_taxid_bat.tsv"/>
71 </test>
72 <test expect_num_outputs="1">
73 <param name="biobox_file" ftype="tabular" value="test_biobox_file.tsv"/>
74 <conditional name="tool_type">
75 <param name="is_select" value="GTDB"/>
76 <param name="gtdb_to_taxdump" ftype="tabular" value="test_gtdb_to_taxdump_file.tsv"/>
77 <param name="taxonkit" ftype="tabular" value="test_taxonkit_file.tsv"/>
78 <param name="column" value="1"/>
79 <param name="input" ftype="tabular" value="test_gtdb_file.tsv"/>
80 </conditional>
81 <output name="output" file="test_biobox_file_add_taxid_gtdb.tsv"/>
82 </test>
83 </tests>
84 <help>
85 <![CDATA[
86
87 **USAGE OF THIS TOOL**
88
89 This tool was desgin for using the BAT/GTDB-Tk output to expand the CAMI amber biobox file with the taxid column to access taxa evaluation with amber!
90
91 **IMPORTAND NOTE WHEN USING GTDB OUTPUT**
92
93 Befor using GTDB-Tk output you have to use 2 other tools to map the GTDB names to the NCBI names and then map the NCBI names to there taxids.
94 To map the GTDB names to the NCBI names you extract the GTDB names from the summary file and with them you can now use the gtdb_to_taxdum tool!
95 After using the gtdb_to_taxdum tool you have the extract the NCBI names here and then use the tool Taxonkit[name2taxid] to finaly get the taxids.
96
97 **INPUTS**
98 - The CAMI amber biobox file
99 - BAT[bin2classifier] file(s) OR GTDB-Tk[Summary] file(s)
100 - The gtdb_to_taxdum output[WHEN USING GTDB-Tk]
101 - The Taxonkit[name2taxid] output[WHEN USING GTDB-Tk]
102
103 **OUTPUT**
104
105 A CAMI amber biobox file with a taxid colum
106 ]]>
107 </help>
108 <citations>
109 <citation type="bibtex">@misc{BibEntry2024Aug,
110 title = {{biobox{$\_$}add{$\_$}taxid}},
111 author = {Santino Faack (SantaMcCloud)},
112 journal = {GitHub},
113 year = {2024},
114 month = aug,
115 note = {[Online; accessed 22. Aug. 2024]},
116 url = {https://github.com/SantaMcCloud/biobox_add_taxid/tree/release-0.3}
117 }</citation>
118 </citations>
119 </tool>