annotate matchms_formatter.xml @ 3:e2a1dbeba196 draft

"planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
author recetox
date Fri, 28 Jan 2022 16:23:30 +0000
parents 52abfe76c25b
children da32f57b4f88
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
1 <tool id="matchms_formatter" name="matchms output formatter" version="0.1.1" python_template_version="3.5">
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
2 <description>reformat output tables of matchms</description>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
3
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
4 <macros>
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
5 <import>macros.xml</import>
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
6 </macros>
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
7 <expand macro="creator"/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
8
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
9 <requirements>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
10 <requirement type="package" version="1.1.4">pandas</requirement>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
11 <requirement type="package" version="8.0.1">click</requirement>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
12 </requirements>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
13
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
14 <command detect_errors="aggressive"><![CDATA[
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
15 sh ${matchms_formatter_cli}
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
16 ]]></command>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
17
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
18 <configfiles>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
19 <configfile name="matchms_formatter_cli">
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
20 python3 ${__tool_directory__}/formatter.py \
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
21 --sf "$scores" \
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
22 --mf "$matches" \
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
23 --o "$output" \
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
24 $method.selection \
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
25 #if $method.selection == "get-thresholded-data"
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
26 --st $method.scores_threshold \
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
27 --mt $method.matches_threshold
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
28 #else
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
29 --k $method.k
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
30 #end if
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
31 </configfile>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
32 </configfiles>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
33
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
34 <inputs>
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
35 <param label="Scores Table" name="scores" type="data" format="csv,tsv" help="Scores output table."/>
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
36 <param label="Matches Table" name="matches" type="data" format="csv,tsv" help="Scores output table."/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
37
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
38 <conditional name="method">
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
39 <param name="selection" type="select" label="Formatting method">
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
40 <option value="get-thresholded-data" selected="true">Thresholding</option>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
41 <option value="get-top-k-data">Top K Matches</option>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
42 </param>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
43 <when value="get-thresholded-data">
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
44 <param label="Scores Threshold" name="scores_threshold" type="float" value="0.6" min="0.0" max="1.0"
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
45 help="Threshold for matching score."/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
46 <param label="Matches Threshold" name="matches_threshold" type="integer" value="3" min="0"
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
47 help="Threshold for number of matches ions."/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
48 </when>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
49 <when value="get-top-k-data">
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
50 <param label="Top K" name="k" type="integer" value="5" help="K for top k match selection."/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
51 </when>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
52 </conditional>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
53
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
54 </inputs>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
55 <outputs>
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
56 <data label="${tool.name} (${method.selection}) on ${on_string}" name="output" format_source="scores"/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
57 </outputs>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
58
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
59 <tests>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
60 <test>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
61 <param name="scores" value="scores_test2_out.tsv" ftype="tsv"/>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
62 <param name="matches" value="matches_test2_out.tsv" ftype="tsv"/>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
63 <param name="selection" value="get-thresholded-data"/>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
64 <param name="scores_threshold" value="0.4"/>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
65 <param name="matches_threshold" value="2"/>
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
66 <output name="output" file="formatter/test2_threshold_formatting.tsv" ftype="tsv"
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
67 checksum="md5$8929cdac47252da638f066261ffc16b7"/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
68 </test>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
69 <test>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
70 <param name="scores" value="scores_test2_out.tsv" ftype="tsv"/>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
71 <param name="matches" value="matches_test2_out.tsv" ftype="tsv"/>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
72 <param name="selection" value="get-top-k-data"/>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
73 <param name="k" value="3"/>
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
74 <output name="output" file="formatter/test2_topk_formatting.tsv" ftype="tsv"
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
75 checksum="md5$a9186721aa2df2f9dbdef5021aa6bc26"/>
0
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
76 </test>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
77 </tests>
0a08bed94964 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 85f60c94ccb3cb7706694cbb7ff6d59dcb41c0c9"
recetox
parents:
diff changeset
78
3
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
79 <help>
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
80 <![CDATA[
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
81 @HELP_formatter@
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
82 ]]>
e2a1dbeba196 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 9bc547872c98a9c13c561d15e8990fe82bdc0e72"
recetox
parents: 2
diff changeset
83 </help>
2
52abfe76c25b "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 46191b39a711f92418f1d412065bbb3648dbf42d"
recetox
parents: 1
diff changeset
84 </tool>