Mercurial > repos > recetox > matchms_metadata_export
annotate matchms_metadata_export.xml @ 0:dfdbccfa8753 draft
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
| author | recetox |
|---|---|
| date | Thu, 18 May 2023 14:07:28 +0000 |
| parents | |
| children | f04610d25411 |
| rev | line source |
|---|---|
|
0
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
1 <tool id="matchms_metadata_export" name="matchms metadata export " version="0.19.0+galaxy0" profile="21.05"> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
2 <description>extract all metadata from mass spectra file to tabular format</description> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
3 <macros> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
4 <import>macros.xml</import> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
5 </macros> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
6 <expand macro="creator"/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
7 <requirements> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
8 <requirement type="package" version="0.19.0">matchms</requirement> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
9 </requirements> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
10 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
11 <command detect_errors='aggressive'><![CDATA[ |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
12 python ${matchms_python_cli} |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
13 ]]></command> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
14 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
15 <configfiles> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
16 <configfile name="matchms_python_cli"> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
17 import pandas |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
18 from matchms.importing import load_from_msp, load_from_mgf |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
19 from matchms.exporting.metadata_export import export_metadata_as_csv |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
20 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
21 spectra_list = list(load_from_${input_file.ext}("${input_file}", $harmonize_metadata)) |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
22 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
23 export_metadata_as_csv(spectra_list, "${output_file}") |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
24 </configfile> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
25 </configfiles> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
26 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
27 <inputs> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
28 <param label="Spectra file" name="input_file" type="data" format="msp,mgf" help="Mass spectral library file."/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
29 <param label="Harmonize metadata" name="harmonize_metadata" type="boolean" truevalue="True" falsevalue="False" |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
30 checked="false" help="Apply harmonization process on the metadata keys (e.g. parse numeric values, derive precursor mass)."/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
31 </inputs> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
32 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
33 <outputs> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
34 <data label="matchms extract metadata on ${on_string}" name="output_file" format="csv"/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
35 </outputs> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
36 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
37 <tests> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
38 <test> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
39 <param name="input_file" value="convert/mgf_out.mgf" ftype="mgf"/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
40 <output name="output_file" file="convert/metadata.csv" ftype="csv" compare="sim_size" delta="0"/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
41 </test> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
42 <test> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
43 <param name="input_file" value="similarity/RECETOX_Exposome_pesticides_HR_MS_20220323.msp" ftype="msp"/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
44 <output name="output_file" file="convert/metadata.csv" ftype="csv" compare="sim_size" delta="0"/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
45 </test> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
46 </tests> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
47 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
48 <help><![CDATA[ |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
49 Documentation |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
50 Mass spectral libraries are often stored in various formats, such as `msp`, `mgf` or `json`. |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
51 This tool can be used to export the metadata accompanying the actual spectral information to a tabular file. |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
52 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
53 During harmonization of metadata, some of the keywords might change during the conversion process to a unified form. |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
54 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
55 For more documentation on the matchms library see https://github.com/matchms/matchms/blob/master/README.rst and https://matchms.readthedocs.io/en/latest/. |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
56 ]]></help> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
57 |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
58 <expand macro="citations"/> |
|
dfdbccfa8753
planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/matchms commit c10d901c526d0895869d18a1d1bdd1ea58ed7473
recetox
parents:
diff
changeset
|
59 </tool> |
