annotate lcmsmatching.xml @ 10:51b9d4a05d11 draft default tip

planemo upload commit c397cd8a93953798d733fd62653f7098caac30ce
author prog
date Tue, 05 Feb 2019 05:30:30 -0500
parents a44cfb065f4c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
1 <!-- vi: se fdm=marker : -->
10
51b9d4a05d11 planemo upload commit c397cd8a93953798d733fd62653f7098caac30ce
prog
parents: 9
diff changeset
2 <tool id="lcmsmatching" name="LCMS matching" version="4.0.2" profile="18.05">
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
3
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
4 <description>Annotation of LCMS peaks using matching on a in-house spectra database or on PeakForest spectra database.</description>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
5
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
6 <!-- Requirements {{{1 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
7 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
8 <requirements>
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
9 <requirement type="package" version="1.2.2">r-biodb</requirement>
10
51b9d4a05d11 planemo upload commit c397cd8a93953798d733fd62653f7098caac30ce
prog
parents: 9
diff changeset
10 <requirement type="package" version="1.20.2">r-getopt</requirement>
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
11 <requirement type="package" version="0.2_15">r-codetools</requirement> <!-- R_VERSION="0.2-15" IMPORTANT Do not remove, used by travis_install_deps.sh script. --> <!-- codetools package is needed because of the following error when running Galaxy on Travis-CI in planemo tests: "code for methods in class “HtmlWriter” was not checked for suspicious field assignments (recommended package ‘codetools’ not available?)". -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
12
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
13 </requirements>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
14
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
15 <!-- Command {{{1 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
16 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
17
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
18 <command>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
19 <![CDATA[
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
20 ## @@@BEGIN_CHEETAH@@@
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
21 $__tool_directory__/lcmsmatching
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
22
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
23 --log-to-stdout
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
24
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
25 ## Input file
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
26 -i "$mzrtinput"
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
27 --input-col-names "$inputfields"
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
28 --rtunit "$inputrtunit"
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
29
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
30 ## Database
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
31 #if $db.dbtype == "inhouse"
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
32 -d file
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
33 --db-fields "$db.dbfields"
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
34 --db-ms-modes "$db.dbmsmodes"
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
35 --db-rt-unit "$db.dbrtunit"
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
36 #end if
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
37 #if $db.dbtype == "peakforest"
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
38 -d peakforest
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
39 --db-token "$db.dbtoken"
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
40 #end if
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
41 --url "$db.dburl"
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
42
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
43 ## M/Z matching
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
44 -m $mzmode -p $mzprec -s $mzshift -u $mztolunit
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
45
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
46 ## Precursor matching
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
47 #if $prec.match == "true"
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
48 --precursor-match --pos-prec "$prec.pos" --neg-prec "$prec.neg"
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
49 #end if
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
50 #if $prec.match == "true" and $chromcols:
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
51 --precursor-rt-tol $tolz
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
52 #end if
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
53
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
54 ## Chromatographic columns options and retention matching
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
55 #if $chromcols:
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
56 -c "$chromcols" --check-cols --rttolx $tolx --rttoly $toly
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
57 #end if
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
58
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
59 ## Table outputs
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
60 -o "$mainoutput" --peak-output-file "$peaksoutput" --same-rows --same-cols
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
61
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
62 ## HTML output
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
63 --html-output-file "$htmloutput" --no-main-table-in-html-output
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
64
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
65 ## Ouput setting
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
66 --molids-sep "$molidssep"
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
67 ## @@@END_CHEETAH@@@
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
68 ]]></command>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
69
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
70 <!-- Inputs {{{1 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
71 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
72
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
73 <inputs>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
74
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
75 <!-- Database {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
76 <!-- **************************************************************** -->
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
77 <conditional name="db">
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
78
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
79 <param name="dbtype" label="Database" type="select" refresh_on_change="true">
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
80 <option value="inhouse">In-house</option>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
81 <option value="peakforest">Peakforest</option>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
82 </param>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
83
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
84 <!-- In-house database parameters {{{3 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
85 <!-- **************************************************************** -->
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
86 <when value="inhouse">
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
87 <!-- Database file -->
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
88 <param name="dburl" label="Database file" type="data" format="tabular,tsv" refresh_on_change="true" help="Decimal: '.', missing: NA, mode: character and numerical, sep: tabular. Retention time values must be in seconds."/>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
89
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
90 <!-- File database field names -->
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
91 <param name="dbfields" label="Column names" type="text" size="256" value="mztheo=mztheo,chromcolrt=chromcolrt,compoundid=compoundid,chromcol=chromcol,msmode=msmode,peakattr=peakattr,pubchemcompid=pubchemcompid,chebiid=chebiid,hmdbid=hmdbid,keggid=keggid" help="The list of column names of your database in-house file, as a coma separated list of key/value pairs."/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
92
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
93 <!-- File database MS modes -->
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
94 <param name="dbmsmodes" label="MS modes" help="Values used for the file database MS modes, as a coma separated list of key/value pairs." type="text" size="64" value="pos=pos,neg=neg"/>
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
95
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
96 <!-- File database RT unit -->
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
97 <param name="dbrtunit" label="Retention time unit" type="select" display="radio" multiple="false" help="">
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
98 <option value="sec">Seconds</option>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
99 <option value="min">Minutes</option>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
100 </param>
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
101
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
102 <param name="dbtoken" type="text" size="32" value="" hidden="true"/>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
103 </when>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
104
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
105 <!-- PeakForest database parameters {{{3 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
106 <!-- **************************************************************** -->
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
107 <when value="peakforest">
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
108 <param name="dburl" type="text" size="128" value="https://metabohub.peakforest.org/rest/" refresh_on_change="true"/>
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
109
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
110 <param name="dbtoken" label="Peakforest security token" type="text" size="32" value="" refresh_on_change="true" help="If you do not have yet a Peakforest token, go to Peakforest website and request one from your account."/>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
111
7
882f2f20028b planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit 608d9e59a0d2dcf85a037968ddb2c61137fb9bce
prog
parents: 6
diff changeset
112 <param name="dbchromcolfield" type="text" size="32" value="" hidden="true"/>
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
113 </when>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
114 </conditional>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
115
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
116 <!-- Input file {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
117 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
118
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
119 <!-- Input file -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
120 <param name="mzrtinput" label="Input file - MZ(/RT) values" type="data" format="tabular,tsv" refresh_on_change="true" help="Decimal: '.', missing: NA, mode: character and numerical, sep: tabular. RT values must be in seconds."/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
121
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
122 <!-- Input field field names -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
123 <param name="inputfields" type="text" label="Input column names" size="64" help="Input file column names, as a coma separated list of key/value pairs." value="mz=mz,rt=rt"/>
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
124
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
125 <!-- Input file RT unit -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
126 <param name="inputrtunit" label="Retention time unit" type="select" display="radio" multiple="false" help="">
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
127 <option value="sec">Seconds</option>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
128 <option value="min">Minutes</option>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
129 </param>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
130
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
131 <!-- M/Z matching {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
132 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
133
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
134 <!-- Mode -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
135 <param name="mzmode" label="MS mode" type="select" display="radio" multiple="false" help="">
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
136 <option value="pos">Positive</option>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
137 <option value="neg">Negative</option>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
138 </param>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
139
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
140 <!-- MZ matching parameters -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
141 <param name="mzprec" label="M/Z precision" type="float" help="" value="5"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
142 <param name="mzshift" label="M/Z shift" type="float" help="" value="0"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
143 <param name="mztolunit" label="M/Z tolerance unit" type="select" display="radio" multiple="false" help="">
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
144 <option value="ppm">PPM</option>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
145 <option value="plain">Plain</option>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
146 </param>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
147
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
148 <!-- RT matching {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
149 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
150
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
151 <!-- List of chromatographic columns -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
152 <param name="chromcols" type="text" label="Chromatographic columns" size="2048" value=""/>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
153
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
154 <!-- Tolerances -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
155 <param name="tolx" label="RTX" help="The retention time tolerance X parameter (in seconds)." type="float" value="5"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
156 <param name="toly" label="RTY" help="The retention time tolerance Y parameter (no unit)." type="float" value="0.8"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
157 <param name="tolz" label="RTZ" help="The retention time tolerance used when precursor matching is enabled." type="float" value="5"/>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
158
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
159 <!-- Precursor matching {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
160 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
161 <conditional name="prec">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
162
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
163 <param name="match" label="Precursor match" type="select">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
164 <option value="false">Off</option>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
165 <option value="true">On</option>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
166 </param>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
167
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
168 <when value="false"></when>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
169 <when value="true">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
170 <!-- Negative precursors -->
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
171 <param name="neg" label="List of negative precursors" type="text" size="128" value="[(M-H)]-,[M-H]-,[(M+Cl)]-,[M+Cl]-" help="">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
172 <sanitizer>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
173 <valid initial="string.printable">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
174 <remove value='"'/>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
175 </valid>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
176 <mapping initial="none">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
177 <add source='"' target='\"'/>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
178 </mapping>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
179 </sanitizer>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
180 </param>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
181
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
182 <!-- Positive precursors -->
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
183 <param name="pos" label="List of positive precursors" type="text" size="128" value="[(M+H)]+,[M+H]+,[(M+Na)]+,[M+Na]+,[(M+K)]+,[M+K]+" help="">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
184 <sanitizer>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
185 <valid initial="string.printable">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
186 <remove value='"'/>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
187 </valid>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
188 <mapping initial="none">
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
189 <add source='"' target='\"'/>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
190 </mapping>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
191 </sanitizer>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
192 </param>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
193 </when>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
194 </conditional>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
195
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
196 <!-- Output format {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
197 <!-- **************************************************************** -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
198
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
199 <!-- Molecule IDs separator character -->
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
200 <param name="molidssep" label="Multiple matches separator character" type="text" size="3" value="|" help="">
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
201 <sanitizer>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
202 <valid initial="string.printable">
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
203 <remove value='"'/>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
204 </valid>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
205 <mapping initial="none">
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
206 <add source='"' target='\"'/>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
207 </mapping>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
208 </sanitizer>
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
209 </param>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
210
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
211 </inputs>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
212
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
213 <!-- Outputs {{{1 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
214 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
215
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
216 <outputs>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
217
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
218 <data name="mainoutput" label="lcmsmatch_${mzrtinput.name}" format="tabular"/>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
219 <data name="peaksoutput" label="lcmsmatch_${mzrtinput.name}_peaks" format="tabular"/>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
220 <data name="htmloutput" label="lcmsmatch_${mzrtinput.name}.html" format="html"/>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
221
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
222 </outputs>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
223
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
224 <!-- Tests {{{1 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
225 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
226
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
227 <tests>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
228
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
229 <!-- Test 1, MZ only {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
230 <!-- **************************************************************** -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
231 <test>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
232 <param name="dbtype" value="inhouse"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
233 <param name="dburl" value="filedb.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
234 <param name="mzrtinput" value="mz-input-small.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
235 <param name="inputfields" value="mz=mz"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
236 <param name="mzmode" value="pos"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
237 <output name="mainoutput" file="test_1_main_output.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
238 <output name="peaksoutput" file="test_1_peaks_output.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
239 <output name="htmloutput" file="test_1_peaks_output.html"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
240 </test>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
241
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
242 <!-- Test 2, MZ & RT {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
243 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
244 <test>
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
245 <param name="dbtype" value="inhouse"/>
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
246 <param name="dburl" value="filedb.tsv"/>
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
247 <param name="mzrtinput" value="mzrt-input-small.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
248 <param name="inputfields" value="mz=mz,rt=rt"/>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
249 <param name="mzmode" value="pos"/>
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
250 <param name="dbrtunit" value="min"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
251 <param name="chromcols" value="col12"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
252 <param name="tolx" value="5"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
253 <param name="toly" value="0.8"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
254 <output name="mainoutput" file="test_2_main_output.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
255 <output name="peaksoutput" file="test_2_peaks_output.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
256 <output name="htmloutput" file="test_2_peaks_output.html"/>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
257 </test>
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
258
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
259 <!-- Test 3, MZ & RT with precursor match {{{2 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
260 <!-- **************************************************************** -->
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
261 <test>
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
262 <param name="dbtype" value="inhouse"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
263 <param name="dburl" value="filedb.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
264 <param name="mzrtinput" value="mzrt-input-small.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
265 <param name="inputfields" value="mz=mz,rt=rt"/>
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
266 <param name="mzmode" value="pos"/>
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
267 <param name="dbrtunit" value="min"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
268 <param name="chromcols" value="col12"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
269 <param name="tolx" value="5"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
270 <param name="toly" value="0.8"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
271 <param name="match" value="true"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
272 <param name="neg" value="[(M-H)]-,[M-H]-"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
273 <param name="pos" value="[(M+H)]+,[M+H]+"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
274 <param name="tolz" value="60"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
275 <output name="mainoutput" file="test_3_main_output.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
276 <output name="peaksoutput" file="test_3_peaks_output.tsv"/>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
277 <output name="htmloutput" file="test_3_peaks_output.html"/>
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
278 </test>
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
279
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
280 </tests>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
281
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
282 <!-- Help {{{1 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
283 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
284
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
285 <help>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
286 <!-- @@@BEGIN_RST@@@ -->
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
287
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
288 ==============
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
289 LC/MS matching
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
290 ==============
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
291
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
292 This tool performs LC/MS matching on an input list of MZ/RT values, using either a provided in-house single file database or a connection to Peakforest database.
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
293
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
294 --------
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
295 Database
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
296 --------
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
297
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
298 When selecting the database, you have the choice between a Peakforest database or an in-house file.
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
299
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
300 For the Peakforest database, a default REST web base address is already provided. But you can change it to use a custom database. A field is also available for setting a token key in case the access to the Peakforest database you want to use is restricted. This is the case of the default database URL.
1
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
301
45e985cd8e9e planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit d4048accde6bdfd5b3e14f5394902d38991854f8-dirty
prog
parents: 0
diff changeset
302 For the in-house file, please refer to the paragraph "Single file database" below.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
303
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
304 -----------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
305 Input files
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
306 -----------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
307
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
308 Be careful to always provide UTF-8 encoded files, unless you do not use special characters at all. For instance, greek letters in molecule names give errors if the file is in latin1 (ISO 8859-1) or Windows 1252 (not distinguishable from latin1) encoding.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
309
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
310 Single file database
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
311 ====================
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
312
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
313 In this case, the database used is provided as a single file by the user, in tabular format, through the *Database file* field. This file must contain a list of MS peaks, with possibly retention times.
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
314 Peaks are "duplicated" as much as necessary. For instance if 3 retention times are available on a compound with 10 peaks in positive mode, then there will be 30 lines for this compound in positive mode.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
315
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
316 The file must contain a header with the column names. The names are free, but must be provided through the *Column names* field as a comma separated list of key/value pairs. See default value as an example. Of course it is much easier if your database file uses the default column names used in the default value of the *Column names* field. The column names shown in the default values, are only the ones used by the algorithm. You can provide any additional columns in your database file, they will be copied in the output.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
317
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
318 Then you must provide the values used to identify the MS modes (positive and negative), using field *MS modes*.
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
319
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
320 A last information about the single file database is the unit of the retention times, either in seconds or in minutes. Use the field "Retention time unit" to provide this information.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
321
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
322 Example of database file (totally fake, no meaning):
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
323
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
324 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
325 | molid | mode | mz | composition | attribution | col | rt | molcomp | molmass | molnames |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
326 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
327 | A10 | "POS" | 112.07569 | "P9Z6W410 O" | "[(M+H)-(H2O)-(NH3)]+" | "colzz" | 5.69 | "J114L6M62O2" | 146.10553 | "Blablaine'" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
328 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
329 | A10 | "POS" | 112.07569 | "P9Z6W410 O" | "[(M+H)-(H2O)-(NH3)]+" | "col12" | 0.8 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
330 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
331 | A10 | "POS" | 112.07569 | "P9Z6W410 O" | "[(M+H)-(H2O)-(NH3)]+" | "somecol" | 8.97 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
332 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
333 | A10 | "POS" | 191.076694 | "P92Z6W413 Na2 O2" | "[(M-H+2Na)]+" | "colAA" | 1.58 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
334 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
335 | A10 | "POS" | 191.076694 | "P92Z6W413 Na2 O2" | "[(M-H+2Na)]+" | "colzz2" | 4.08 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
336 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
337 | A10 | "POS" | 294.221687 | "U1113P94ZW429 O4" | "[(2M+H)]+ (13C)" | "somecol" | 8.97 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
338 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
339 | A10 | "POS" | 72.080775 | "P9Z4W410 O0" | "[(M+H)-(J15L2M6O2)]+" | "hcoltt" | 0.8 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
340 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
341 | A10 | "POS" | 112.07569 | "P9Z6W410 O" | "[(M+H)-(H2O)-(NH3)]+" | "colzz3" | 4.54 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
342 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
343 | A10 | "POS" | 72.080775 | "P9Z4W410 O0" | "[(M+H)-(J15L2M6O2)]+" | "colzz3" | 4.54 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
344 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
345 | A10 | "POS" | 72.080775 | "P9Z4W410 O0" | "[(M+H)-(J15L2M6O2)]+" | "colpp" | 0.89 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
346 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
347 | A10 | "POS" | 145.097154 | "P92Z6W413 O2" | "[(M+H)-(H2)]+" | "hcoltt" | 0.8 | "J114L6M62O2" | 146.10553 | "Blablaine" |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
348 +-------+-------+------------+--------------------+-------------------------+-----------+-------+---------------+-----------+--------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
349
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
350 The corresponding value of the *Column names* field for this database field would be:
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
351 **mztheo=mz,chromcolrt=rt,compoundid=molid,chromcol=col,msmode=mode,peakattr=attribution**.
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
352
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
353 And the value of the *MS modes* field would be: **pos=POS,neg=NEG**.
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
354
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
355 MZ/RT input file
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
356 ================
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
357
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
358 The input to provide is a dataset in a tabular format (or TSV: Tab Seperated Values), containing the list of M/Z values, with possibly also RT values. The dataset is chosen through the field *Input file - MZ(/RT) values*.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
359
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
360 The column names for the M/Z and RT values must be provided through the field *Input column names*, as a comma separated list of key/value pairs.
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
361 The file/dataset must contain a header line with the same names specified in the field *Input column names*.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
362
6
b8f70d8216b3 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit b3a4e34cf9356447ae3507cc6fe2ff6a1f24afbc-dirty
prog
parents: 5
diff changeset
363 The unit of the retention time has to be provided with the field *Retention time unit*.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
364
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
365 Example of file input:
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
366
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
367 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
368 | mz | rt |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
369 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
370 | 75.02080998 | 49.38210915 |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
371 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
372 | 75.05547146 | 0.658528069 |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
373 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
374 | 75.08059797 | 1743.94267 |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
375 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
376 | 76.03942694 | 51.23158899 |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
377 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
378 | 76.07584477 | 50.51249853 |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
379 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
380 | 76.07593168 | 0.149308136 |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
381 +-------------+-------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
382
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
383 ------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
384 M/Z matching
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
385 ------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
386
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
387 In the simplest form of the algorithm only the *M/Z* values are matched against the database peaks. This happens if both *Retention time match* and *Precursor match* are off.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
388
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
389 The first parameter is the MS mode, specified through the *MS mode* parameter.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
390
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
391 The parameters *M/Z precision* and *M/Z shift* are used by the algorithm in the following formula in order to match an *M/Z* value:
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
392
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
393 mz - shift - precision &lt; mzref &lt; mz - shift + precision
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
394
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
395 Where *mzref* is the M/Z of reference from the database peak that is tested. If this double inequality is true, then the *M/Z* value is matched with this peak.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
396
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
397 The parameters *shift* and *precision* can be input in either PPM values of M/Z or in plain values. Use the field *M/Z tolerance unit* to set the unit.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
398
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
399 --------------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
400 Retention time match
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
401 --------------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
402
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
403 If at least one column is selected inside the *Chromatographic columns* parameter section, then retention time is also matched, in addition to the *M/Z* value, according to the following formula:
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
404
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
405 rt - x - rt^y &lt; colrt &lt; rt + x + rt^y
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
406
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
407 Where *x* is the value of the parameter *RTX* and *y* the value of the parameter *RTY*.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
408
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
409 If for a reference compound the database does not contain retention time for at least one of the specified columns, then only the *M/Z* value is matched against the peaks of the reference compound. This means that in the results you can find compounds that do no match the provided retention time value.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
410
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
411 The *RTZ* parameter is used in the *Precursor match* algorithm (see below).
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
412
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
413 ---------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
414 Precursor match
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
415 ---------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
416
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
417 If the "Precursor match" option is enabled inside the parameters section, then a more sophisticated version of the algorithm, which is executed in two steps, is used.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
418
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
419 This algorithm takes two more parameters, one for each MS mode. These are the lists of precursors. Since the matching is run for one MS mode only, only one of the two parameters is used. Inside the single file database, all the peaks whose **peakattr** column value is equal to one of the precursor listed in *List of negative precursors* or *List of positive precursors*, depending on the mode, are considered as precursor peaks.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
420
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
421 M/Z matching using precursor matching
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
422 =====================================
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
423
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
424 1. Using the normal M/Z matching algorithm described above, we first look only for precursor peaks ([(M+H)]+, [(M+Na)]+, [(M+Cl)]-, ...).
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
425 2. From step 1, we construct a list of matched molecules.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
426 3. We look at all peaks inside the molecule list obtained in step 2, using the normal M/Z matching algorithm described above.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
427
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
428 MZ/RT matching using precursor matching
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
429 =======================================
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
430
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
431 1. Using the normal MZ/RT matching algorithm described above, we first look only for precursor peaks ([(M+H)]+, [(M+Na)]+, [(M+Cl)]-, ...).
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
432 2. From step 1, we construct a list of matched molecules, retaining the matched retention time of each molecule.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
433 3. For each input couple (m/z,rt), we look at all peaks inside the molecules taken from step 2, whose matched retention time between *rt - z* and *rt + z*, where *z* is the value of parameter *RTZ*.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
434
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
435 ---------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
436 Output settings
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
437 ---------------
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
438
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
439 The *Multiple matches separator character* is used to customize the character used to separate the multiple values inside each row in the *main* output dataset. The *main* output contains as much rows as the MZ/RT input dataset, thus when for one MZ/RT value the algorithm finds more than one match, it concatenates the matches using this separator character.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
440
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
441 Output files
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
442 ============
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
443
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
444 Three files are output by the tool.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
445
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
446 +-------------+--------------------------------------+--------------------------------------------------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
447 | Outputs | File name | Description |
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
448 +-------------+--------------------------------------+--------------------------------------------------------+
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
449 | Main output | lcmsmatching_{input_file_name} | Contains the same data as the input dataset, with |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
450 | | | match result included on each row. If more than one |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
451 | | | match is found for a row, the different values of the |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
452 | | | match are concatenated using the provided separator |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
453 | | | character. |
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
454 +-------------+--------------------------------------+--------------------------------------------------------+
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
455 | Peak list | lcmsmatching_{input_file_name}_peaks | Contains the same data as the input dataset, with |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
456 | | | match result included on each row. If more than one |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
457 | | | match is found for a row, then the row is duplicated. |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
458 | | | Hence there is either no match for a row, or one |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
459 | | | single match. |
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
460 +-------------+--------------------------------------+--------------------------------------------------------+
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
461 | HTML output | lcmsmatching_{input_file_name}.html | Contains the same table as *Peak list* but in HTML |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
462 | | | format and with links to external databases if columns |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
463 | | | for PubChem Compound, ChEBI, HMDB Metabolites or KEGG |
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
464 | | | Compounds are provided. |
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
465 +-------------+--------------------------------------+--------------------------------------------------------+
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
466
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
467 The match results are output as new columns appended to the columns provided inside the MZ/RT input dataset, and prefixed with "lcmsmatching.".
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
468
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
469 =====
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
470 About
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
471 =====
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
472
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
473 .. class:: infomark
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
474
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
475 **Author**
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
476 Pierrick Roger (pierrick.roger@cea.fr) wrote this MS matching method.
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
477 MetaboHUB: The French National Infrastructure for Metabolomics and Fluxomics (http://www.metabohub.fr/en).
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
478
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
479 .. class:: infomark
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
480
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
481 **Acknowledgement**
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
482 Data and algorithms have been kindly provided by Christophe Junot at *DSV/IBITEC-S/SPI* (*CEA/Saclay*), from a former application developped by Cyrille Petat and Arnaud Martel at *DSV/IBITEC-S/DIR* (*CEA/Saclay*).
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
483
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
484 .. class:: infomark
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
485
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
486 **Please cite**
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
487 R Core Team (2013). R: A language and Environment for Statistical Computing. http://www.r-project.org.
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
488
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
489 ==============
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
490 Changelog/News
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
491 ==============
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
492
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
493 **Version 4.0.0 - 02/01/2019**
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
494
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
495 - NEW: Use of R biodb library. Connection to databases and matching have been moved to biodb library, which is maintained separately at http://github.com/pkrog/biodb.
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
496
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
497 <!-- @@@END_RST@@@ -->
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
498 </help>
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
499
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
500 <!-- Citations {{{1 -->
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
501 <!-- **************************************************************** -->
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
502
8
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
503 <citations>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
504 <citation type="bibtex">@unpublished{FGiacomoni2017,
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
505 title = {PeakForest [Internet], a spectral data portal for Metabolomics community - storing, curating and annotation services for metabolic profiles of biological matrix.},
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
506 author = {Franck Giacomoni, Nils Paulhe},
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
507 institution = {INRA / MetaboHUB},
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
508 year = {2017},
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
509 note = {Unpublished paper, available from: https://peakforest.org/.}
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
510 }</citation>
0f079ad77bdf planemo upload commit b90b06e871eca4f3413216a3812be97668a18f76-dirty
prog
parents: 7
diff changeset
511 </citations>
0
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
512
3afe41d3e9e7 planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit bb4d3e23d99828bfee16d31d794c49a17313ec2f
prog
parents:
diff changeset
513 </tool>