Mercurial > repos > recetox > matchms_subsetting

annotate help.xml @ 18:6ac4a790adad draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit bd80a813fb2f01f22eed0c874f8911ce4d00762a
author recetox
date Mon, 30 Jun 2025 13:05:31 +0000
parents c4835715c7ac
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
1 <macros>
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
2 <token name="@HELP_matchms@">
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
3 Documentation
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
4 The Python library matchms provides functions to convert, filter and compare mass spectrometry data.
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
5 For an overview of the different galaxy modules, see the figure below.
18
6ac4a790adad planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit bd80a813fb2f01f22eed0c874f8911ce4d00762a
recetox
parents: 14
diff changeset
6 For detailed documentation on the tool, see https://matchms.readthedocs.io/en/latest/ for the Python API.
0
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
7
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
8 Overview
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
9 .. image:: https://github.com/RECETOX/galaxytools/raw/29e54e69dab6ab1263f56d35ea19f5d7f284d728/tools/matchms/images/matchms_galaxytools.png
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
10 :width: 3120
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
11 :height: 1686
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
12 :scale: 30
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
13 :alt: Overview of different matchms galaxytools and how they are connected.
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
14 </token>
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
15 <token name="@HELP_matchms_networking@">
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
16 <![CDATA[
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
17 Documentation
18
6ac4a790adad planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit bd80a813fb2f01f22eed0c874f8911ce4d00762a
recetox
parents: 14
diff changeset
18 For documentation on the tool see https://matchms.readthedocs.io/en/latest/.
0
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
19
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
20 **Upstream Tools**
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
21
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
22 matchms similarity
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
23
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
24 **Downstream Tools**
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
25
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
26 The output is a network-graph file that can be visualized using graph visualization software (e.g., Cytoscape).
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
27 ]]>
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
28 </token>
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
29
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
30 <token name="@HELP_formatter@">
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
31 <![CDATA[
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
32 Usage
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
33 This tool creates user friendly tables from the similarity scores produced by **matchms similarity**.
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
34 The tool can be operated on two modes based on (i) thresholds or (ii) top k matches.
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
35
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
36 Input Table Format
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
37 The tool expects a JSON file containing serialized matchms Scores object.
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
38
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
39 Output Table Format
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
40 +----------+-----------+---------+--------+
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
41 | query | reference | matches | scores |
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
42 +==========+===========+=========+========+
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
43 | C001 | Glycine | 6 | 0.5 |
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
44 +----------+-----------+---------+--------+
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
45 | C002 | Glycine | 3 | 0.34 |
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
46 +----------+-----------+---------+--------+
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
47 | ... | ... | ... | ... |
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
48 +----------+-----------+---------+--------+
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
49 ]]>
2b61ec493df6 planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit a0565620150b69e0ca87aa686709c25356436f71
recetox
parents:
diff changeset
50 </token>
14
c4835715c7ac planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit 113433b8b9790405c2c5d054aee4a29a21b77dc7
recetox
parents: 0
diff changeset
51 </macros>