annotate data_manager/malt_index_builder.xml @ 0:d69ebf52c233 draft

Uploaded
author greg
date Tue, 12 Oct 2021 14:15:35 +0000
parents
children 787f1ca9045a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d69ebf52c233 Uploaded
greg
parents:
diff changeset
1 <tool id="data_manager_malt_index_builder" name="MALT index builder" tool_type="manage_data" version="0.5.3+galaxy0" profile="21.01">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
2 <description></description>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
3 <requirements>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
4 <requirement type="package" version="0.53">malt</requirement>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
5 </requirements>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
d69ebf52c233 Uploaded
greg
parents:
diff changeset
7 python '$__tool_directory__/malt_index_builder.py'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
8 '${out_file}'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
9 --fasta_filename '${all_fasta_source.fields.path}'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
10 --fasta_dbkey '${all_fasta_source.fields.dbkey}'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
11 --fasta_description '${all_fasta_source.fields.name}'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
12 --sequence_type '${sequence_type}'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
13 #if str($seed_setting_cond.seed_setting) == 'yes':
d69ebf52c233 Uploaded
greg
parents:
diff changeset
14 --shapes '${seed_setting_cond.shapes}'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
15 --max_hits_per_seed $seed_setting_cond.max_hits_per_seed
d69ebf52c233 Uploaded
greg
parents:
diff changeset
16 --protein_reduct '${seed_setting_cond.protein_reduct}'
d69ebf52c233 Uploaded
greg
parents:
diff changeset
17 #end if
d69ebf52c233 Uploaded
greg
parents:
diff changeset
18 ]]></command>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
19 <inputs>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
20 <param name="all_fasta_source" type="select" label="Source FASTA Sequence">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
21 <options from_data_table="all_fasta"/>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
22 </param>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
23 <param name="sequence_name" type="text" value="" label="Name of sequence" />
d69ebf52c233 Uploaded
greg
parents:
diff changeset
24 <param name="sequence_id" type="text" value="" label="ID for sequence" />
d69ebf52c233 Uploaded
greg
parents:
diff changeset
25 <param name="sequence_type" type="select" label="Specify whether the reference sequences are DNA or Protein sequences" help="Use the DNA setting For RNA sequences">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
26 <option value="DNA" selected="true">DNA</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
27 <option value="Protein">Protein</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
28 </param>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
29 <conditional name="seed_setting_cond">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
30 <param name="seed_setting" type="select" label="Specify seed settings?">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
31 <option selected="true" value="no">No</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
32 <option value="yes">Yes</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
33 </param>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
34 <when value="no"/>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
35 <when value="yes">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
36 <param name="shapes" type="text" value="" label="Comma-separated list of seed shapes" help="See help text below">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
37 <sanitizer invalid_char="">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
38 <valid initial="string.printable">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
39 <remove value="&apos;" />
d69ebf52c233 Uploaded
greg
parents:
diff changeset
40 </valid>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
41 <mapping initial="none">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
42 <add source="&apos;" target="&apos;&quot;&apos;&quot;&apos;" />
d69ebf52c233 Uploaded
greg
parents:
diff changeset
43 </mapping>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
44 </sanitizer>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
45 </param>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
46 <param name="max_hits_per_seed" type="integer" value="1" min="1" label="Maximum number of hits per seed"/>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
47 <param name="protein_reduct" type="select" label="Name or definition of protein alphabet reduction">
d69ebf52c233 Uploaded
greg
parents:
diff changeset
48 <option selected="true" value="DIAMOND_11">DIAMOND_11</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
49 <option value="BLOSUM50_10">BLOSUM50_10</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
50 <option value="BLOSUM50_11">BLOSUM50_11</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
51 <option value="BLOSUM50_15">BLOSUM50_15</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
52 <option value="BLOSUM50_4">BLOSUM50_4</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
53 <option value="BLOSUM50_8">BLOSUM50_8</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
54 <option value="GBMR4">GBMR4</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
55 <option value="HSDM17">HSDM17</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
56 <option value="MALT_10">MALT_10</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
57 <option value="SDM12">SDM12</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
58 <option value="UNREDUCED">UNREDUCED</option>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
59 </param>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
60 </when>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
61 </conditional>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
62 </inputs>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
63 <outputs>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
64 <data name="out_file" format="data_manager_json" />
d69ebf52c233 Uploaded
greg
parents:
diff changeset
65 </outputs>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
66 <tests>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
67 <test>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
68 <param name="all_fasta_source" value="phiX174"/>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
69 <output name="out_file" value="malt_index_builder.json"/>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
70 </test>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
71 </tests>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
72 <help>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
73 .. class:: infomark
d69ebf52c233 Uploaded
greg
parents:
diff changeset
74
d69ebf52c233 Uploaded
greg
parents:
diff changeset
75 **Notice:** Values for name, description, and id will be generated automatically if left blank.
d69ebf52c233 Uploaded
greg
parents:
diff changeset
76
d69ebf52c233 Uploaded
greg
parents:
diff changeset
77 **What it does**
d69ebf52c233 Uploaded
greg
parents:
diff changeset
78
d69ebf52c233 Uploaded
greg
parents:
diff changeset
79 Takes a reference sequence database (represented by a FastA file, possibly in gzip format) as input and produces an index that
d69ebf52c233 Uploaded
greg
parents:
diff changeset
80 can be used by the malt tool as input. If MALT is to be used as a taxonomic and/or functional analysis tool as well as an
d69ebf52c233 Uploaded
greg
parents:
diff changeset
81 alignment tool, then this MALT index builder tool must be provided with a number of mapping files that are used to map reference
d69ebf52c233 Uploaded
greg
parents:
diff changeset
82 sequences to taxonomic or functional classes or to locate genes in DNA reference sequences.
d69ebf52c233 Uploaded
greg
parents:
diff changeset
83
d69ebf52c233 Uploaded
greg
parents:
diff changeset
84 **Options**
d69ebf52c233 Uploaded
greg
parents:
diff changeset
85
d69ebf52c233 Uploaded
greg
parents:
diff changeset
86 * **Specify seed settings** - specify the settings for controlling how MALT uses its seed-and-extend approach based on “spaced seeds”.
d69ebf52c233 Uploaded
greg
parents:
diff changeset
87
d69ebf52c233 Uploaded
greg
parents:
diff changeset
88 * **Shapes** - specify the seed shapes used. For DNA sequences, the default seed shape is: 111110111011110110111111. For protein sequences, by default MALT uses the following four shapes: 111101101110111, 1111000101011001111, 11101001001000100101111 and 11101001000010100010100111.
d69ebf52c233 Uploaded
greg
parents:
diff changeset
89 * **Maximim hits per seed** - specify the maximum number of hits per seed - MALT uses this to calculate a maximum number of hits per hash value.
d69ebf52c233 Uploaded
greg
parents:
diff changeset
90 * **Protein reduction** - specify the alphabet reduction in the case of protein reference sequences. By default, MALT reduces amino acids to 8 different letters, grouped as follows: [LVIMC] [AG] [ST] [P] [FYW] [EDNQ] [KR] [H].
d69ebf52c233 Uploaded
greg
parents:
diff changeset
91 </help>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
92 <citations>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
93 <citation type="doi">https://doi.org/10.1101/050559</citation>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
94 </citations>
d69ebf52c233 Uploaded
greg
parents:
diff changeset
95 </tool>