annotate data_manager/kma_build_index.xml @ 3:def26737cedb draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
author iuc
date Fri, 10 Oct 2025 12:03:01 +0000
parents eb620aa70b61
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
3
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
2 <tool id="kma_build_index" name="KMA Index Builder" tool_type="manage_data" version="1.6.6+galaxy0" profile="24.1">
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
3 <description>kma index builder</description>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
4 <requirements>
3
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
5 <requirement type="package" version="1.6.6">kma</requirement>
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
6 </requirements>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
7 <version_command>kma -v</version_command>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
8 <command detect_errors="exit_code">
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
9 <![CDATA[
3
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
10 mkdir -p '${out_file.extra_files_path}'/index_folder &&
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
11 kma_index
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
12 -i '$fasta'
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
13 -o '${out_file.extra_files_path}'/index_folder/index
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
14 ## index options
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
15 -k $k
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
16 -k_t $k_t
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
17 -k_i $k_i
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
18 -ML $ML
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
19 -ht $ht
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
20 -hq $hq
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
21 ]]></command>
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
22 <configfiles>
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
23 <configfile filename="dm.json"><![CDATA[#slurp
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
24 #from datetime import datetime
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
25 #from hashlib import md5
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
26 #set value=datetime.now().strftime("%Y-%m-%d") + "_" + md5($name.encode()).hexdigest()
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
27 {"data_tables": {"kma_index": [{"value": "$value", "name": "$name", "path": "index_folder"}]}}
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
28 ]]></configfile>
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
29 </configfiles>
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
30 <inputs>
3
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
31 <param argument="-k" type="integer" value="16" min="8" max="32" label="kmer size used for indexing the database." />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
32 <param argument="-k_t" type="integer" value="16" min="8" max="32" label="kmer size used to identify template candidates when running KMA." />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
33 <param argument="-k_i" type="integer" value="16" min="8" max="32" label="kmer size used when performing alignments between two sequences." />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
34 <param argument="-ML" type="integer" value="16" label="Minimum length of templates" />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
35 <param argument="-ht" type="float" value="1.0" min="0.0" max="1.0" label="Homology template" />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
36 <param argument="-hq" type="float" value="1.0" min="0.0" max="1.0" label="Homology query" />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
37 <param name="fasta" type="data" format="fasta" label="Sequence to index (fasta)" />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
38 <param name="name" type="text" optional="false" label="Name for index" help="Choose a name that describes the indexed sequence and possibly any non-default indexing parameters.">
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
39 <validator type="empty_field"/>
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
40 </param>
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
41 </inputs>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
42 <outputs>
3
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
43 <data name="out_file" format="data_manager_json" from_work_dir="dm.json"/>
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
44 </outputs>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
45 <tests>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
46 <test>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
47 <param name="fasta" value="phiX174.fasta"/>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
48 <param name="name" value="index"/>
3
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
49 <output name="out_file" ftype="data_manager_json">
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
50 <assert_contents>
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
51 <has_text text='"kma_index":' />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
52 <has_text text='"name": "index"' />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
53 <has_text text='"path": "index_folder"' />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
54 <has_text_matching expression='"value": "\d{4}-\d{2}-\d{2}_6a992d5529f459a44fee58c733255e86"' />
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
55 </assert_contents>
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
56 </output>
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
57 </test>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
58 </tests>
3
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
59 <help><![CDATA[
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
60 **Data manager for building an index for the kma aligner**
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
61
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
62 Runs the kma index command on the input sequence with the chosen options.
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
63
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
64 .. class:: infomark
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
65
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
66 You may want to capture details about the reference sequence and any non-default indexing parameters in the name of the index so that users have a better idea what they are selecting for tool runs.
def26737cedb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit d0b3d69f25fe8419e5b98165ae53b59651d711b1
iuc
parents: 0
diff changeset
67 ]]></help>
0
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
68 <citations>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
69 <citation type="doi">10.1186/s12859-018-2336-6</citation>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
70 </citations>
eb620aa70b61 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_kma_index/ commit cf775591e6aa55798abe20c77572761076cc535f"
iuc
parents:
diff changeset
71 </tool>