annotate comebin.xml @ 1:15f6ef1d7c96 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit a298275e9754bf6bc71e5ee794121bbc6b3d426c
author iuc
date Wed, 30 Jul 2025 11:47:15 +0000
parents 2576c9132481
children ddfb9c10740a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
1 <tool id="comebin" name="COMEBin" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
2 <description>Binning of metagenomic contigs using COntrastive Multi-viEw representation learning</description>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
3 <macros>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
4 <import>macros.xml</import>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
5 </macros>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
7 <command detect_errors="exit_code">
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
8 <![CDATA[
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
9
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
10 #import re
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
11
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
12 mkdir 'outputs' 'bam_files' &&
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
13
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
14 #set $safename = re.sub('[^\w\-_\.]', '_', $assembly_file.element_identifier)
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
15 ln -s '$assembly_file' '${safename}.fasta' &&
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
16
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
17 #for $file in $bam_files:
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
18 #set $safename = re.sub('[^\w\-_\.]', '_', $file.element_identifier)
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
19 ln -s '$file' './bam_files/${safename}.bam' &&
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
20 #end for
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
21
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
22 run_comebin.sh
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
23 -a 'assembly_file.fasta'
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
24 -o 'outputs'
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
25 -p 'bam_files'
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
26 -t \${GALAXY_SLOTS:-12}
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
27 -l ${loss}
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
28 -n ${learning}
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
29 -e ${emb_comebin}
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
30 -c ${emb_cov}
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
31 -b ${batch}
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
32
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
33 ]]>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
34 </command>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
35 <inputs>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
36 <param name="assembly_file" type="data" format="fasta" label="Metagenomic assembly file"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
37 <param name="bam_files" type="data" format="bam" multiple="true" label="Input bam file(s)"/>
1
15f6ef1d7c96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit a298275e9754bf6bc71e5ee794121bbc6b3d426c
iuc
parents: 0
diff changeset
38 <param name="learning" type="integer" value="6" label="Views for contrastive multiple-view learning"/>
15f6ef1d7c96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit a298275e9754bf6bc71e5ee794121bbc6b3d426c
iuc
parents: 0
diff changeset
39 <param name="loss" type="float" value="0.15" label="Temperature in loss function" help="0.07 is recommended for assemblies with an N50 > 10000"/>
15f6ef1d7c96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit a298275e9754bf6bc71e5ee794121bbc6b3d426c
iuc
parents: 0
diff changeset
40 <param name="emb_comebin" type="integer" value="2048" label="Embedding size for COMEBin network"/>
15f6ef1d7c96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit a298275e9754bf6bc71e5ee794121bbc6b3d426c
iuc
parents: 0
diff changeset
41 <param name="emb_cov" type="integer" value="2048" label="Embedding size for coverage network"/>
15f6ef1d7c96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit a298275e9754bf6bc71e5ee794121bbc6b3d426c
iuc
parents: 0
diff changeset
42 <param name="batch" type="integer" value="1024" label="Batch size"/>
0
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
43 </inputs>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
44 <outputs>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
45 <collection name="bins" type="list" format="fasta" label="${tool.name}: BINS">
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
46 <discover_datasets pattern="__name__" directory="outputs/comebin_res/comebin_res_bins/"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
47 </collection>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
48 </outputs>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
49 <tests>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
50 <test expect_exit_code="1" expect_failure="true">
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
51 <param name="assembly_file" ftype="fasta" value="input_single.fasta"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
52 <param name="bam_files" ftype="bam" value="input_single.bam"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
53 <param name="learning" value="6"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
54 <param name="loss" value="0.15"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
55 <param name="emb_comebin" value="2048"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
56 <param name="emb_cov" value="2048"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
57 <param name="batch" value="1024"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
58 </test>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
59 </tests>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
60 <help>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
61 <![CDATA[
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
62
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
63 **IMPORTANT**
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
64
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
65 It might happen that this tool will throw out an error. If this error happen: ValueError: max() arg is an empty sequence
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
66 then try to run this tool with different values it might fix this. When this error happen: UnboundLocalError: local variable 'logits' referenced before assignment
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
67 then the imputed data might not be enough such that this tool will function correctly.
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
68
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
69 Also the run-time of this tool will be high since it is machining learning tool for binning!
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
70
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
71 **Input**
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
72
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
73 - The assembly file in fasta format
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
74 - The corresponded bam file(s) to the assembly file
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
75
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
76 **Output**
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
77
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
78 As output from the tool is a collection of bins created with machining learning
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
79
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
80
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
81 ]]>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
82 </help>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
83 <expand macro="citations"/>
2576c9132481 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/comebin/ commit 392e72b84376b11b19759ba85261d99f05c4f64e
iuc
parents:
diff changeset
84 </tool>