annotate data_manager/mash_sketch_builder.xml @ 3:7197573e88b9 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit 096286097ed5cdf189a1b68c3fc34d10f4142e54
author iuc
date Sun, 16 Apr 2023 08:30:43 +0000
parents 2af9137ba067
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
2 <tool id="mash_sketch_builder" name="Mash Sketch" tool_type="manage_data" version="@TOOL_VERSION@+galaxy0" profile="18.09">
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
3 <description>builder</description>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
4 <requirements>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
5 <requirement type="package" version="@TOOL_VERSION@">mash</requirement>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
6 <requirement type="package" version="3.7">python</requirement>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
7 </requirements>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
8 <macros>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
9 <token name="@TOOL_VERSION@">2.1</token>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
10 </macros>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
11 <version_command>mash --version</version_command>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
12 <command detect_errors="exit_code">
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
13 <![CDATA[
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
14 python '$__tool_directory__/mash_sketch_builder.py'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
15 '${out_file}'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
16 --threads \${GALAXY_SLOTS:-1}
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
17 #if str( $input_sequence_source.input_sequence_source_selector ) == "tool_data_table":
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
18 --fasta '${input_sequence_source.input_sequence.fields.path}'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
19 #elif str( $input_sequence_source.input_sequence_source_selector ) == 'history':
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
20 --fasta '${input_sequence_source.input_sequence}'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
21 #end if
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
22 --sketch-name '${sketch_name}'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
23 --sketch-size '${sketch_size}'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
24 --kmer-size '${kmer_size}'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
25 --probability-threshold '${probability_threshold}'
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
26 ${individual_sequences}
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
27 ]]>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
28 </command>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
29 <inputs>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
30 <conditional name="input_sequence_source">
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
31 <param name="input_sequence_source_selector" type="select"
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
32 label="Select a sequence from your history or use one from a tool data table?">
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
33 <option value="tool_data_table">Sequence from tool data table</option>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
34 <option selected="True" value="history">Sequence from history</option>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
35 </param>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
36 <when value="tool_data_table">
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
37 <param name="input_sequence" type="select" label="Source FASTA Sequence">
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
38 <options from_data_table="all_fasta"/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
39 </param>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
40 </when>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
41 <when value="history">
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
42 <param name="input_sequence" type="data" format="fasta" label="Input sequence" help=""/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
43 </when>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
44 </conditional>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
45 <param type="text" name="sketch_name" label="Sketch name" help="Human-readable description of the sketch"/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
46 <param type="integer" name="sketch_size" value="1000" min="10" max="1000000" label="Sketch size" help="Each sketch will have at most this many non-redundant min-hashes."/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
47 <param type="integer" name="kmer_size" value="21" min="1" max="32" label="K-mer size" help="Hashes will be based on strings of this many nucleotides."/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
48 <param type="float" name="probability_threshold" value="0.01" min="0." max="1." label="Probability threshold for warning about low k-mer size." />
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
49 <param type="boolean" name="individual_sequences" truevalue="--individual-sequences" falsevalue="" label="Sketch individual sequences" help="e.g. for multi-fastas of single-chromosome genomes or pair-wise gene comparisons."/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
50 </inputs>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
51 <outputs>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
52 <data name="out_file" format="data_manager_json" />
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
53 </outputs>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
54 <tests>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
55 <test>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
56 <param name="input_sequence_source_selector" value="history"/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
57 <param name="input_sequence" value="test_assembly.fasta"/>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
58 <param name="sketch_name" value="Test Sketch" />
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
59 <output name="out_file" value="mash_sketch_data_manager.json" compare="sim_size" />
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
60 </test>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
61 </tests>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
62 <help><![CDATA[
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
63
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
64 **What it does**
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
65
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
66 Create a sketch file, which is a reduced representation of a sequence or set
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
67 of sequences (based on min-hashes) that can be used for fast distance
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
68 estimations. For output, one sketch file will be generated, but it can have
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
69 multiple sketches within it, divided by sequences or files.
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
70 ]]></help>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
71 <citations>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
72 <citation type="doi">10.1186/s13059-016-0997-x</citation>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
73 </citations>
2af9137ba067 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_mash_sketch_builder/ commit c6efcbece52dec310253537b35419839746fff7f"
iuc
parents:
diff changeset
74 </tool>