annotate eics_centroids.xml @ 5:c27ac1eda51b draft default tip

Uploaded
author jcb-mpl
date Fri, 13 May 2022 15:04:50 +0000
parents 5f444a41ee0a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
1 <tool id="2021_05_eics_centroids" name="MS .h5 or .dat -> MS-centroid" version="0.0.1">
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
2
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
3 <description> </description>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
4
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
5 <requirements>
5
c27ac1eda51b Uploaded
jcb-mpl
parents: 2
diff changeset
6 <requirement type="package" version="6.1.1">scilab</requirement>
2
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
7 </requirements>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
8
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
9
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
10 <stdio>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
11 <exit_code range="1:" level="fatal" />
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
12 </stdio>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
13
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
14
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
15 <command>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
16 <![CDATA[
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
17 $__root_dir__/packages/scilab-*/bin/scilab-cli -nb -quit -f ${script_file}
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
18 ]]>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
19 </command>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
20
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
21 <configfiles>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
22 <configfile name="script_file">
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
23 <![CDATA[ exec("$__tool_directory__/src/mz_1bis_signal_threshold.sci",-1); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
24 exec("$__tool_directory__/src/mz_2_barycenter_adjust2.sci",-1); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
25 exec("$__tool_directory__/src/mz_2_savgol2.sci",-1); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
26 exec("$__tool_directory__/src/mz_3_remove_zeros.sci",-1); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
27 exec("$__tool_directory__/src/mz_eic5_step1.sci",-1); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
28 exec("$__tool_directory__/src/mz_hdf5tosci.sci",-1); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
29 if ~isdef('pls') then ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
30 atomsSystemUpdate(); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
31 atomsInstall('FACT'); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
32 atomsLoad('FACT'); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
33 end; ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
34 lasterror(); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
35 type_sm=${type_sm}; ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
36 format_io=${format_io}; ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
37 if type_sm==1 then ... // mode profil Orbitrap
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
38 if format_io==0 then ... // format Scilab
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
39 load("${filein}"); ... // la variable doit s'appeler res
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
40 elseif format_io==1 then ... // format HDF5
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
41 res=mz_hdf5tosci("${filein}"); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
42 end; ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
43 resbary=mz_eic5_step1(res,${signalthresh}); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
44 elseif type_sm==0 then ... // mode centroide
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
45 if format_io==0 then ... // format Scilab = on ne fait rien
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
46 load("${filein}"); ... // la variable doit deja s'appeler resbary
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
47 elseif format_io==1 then ... // format HDF5
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
48 res=mz_hdf5tosci("${filein}"); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
49 resbary=mz_3_remove_zeros(res); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
50 end; ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
51 end; ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
52 save("${resbary}",'resbary'); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
53 if ~isempty(lasterror(%f)) then ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
54 write(0,lasterror()); ...
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
55 end; ]]>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
56 </configfile>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
57 </configfiles>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
58
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
59
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
60 <inputs>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
61 <param name="format_io" type="select" size="5" format="integer" label="MS format" >
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
62 <option value="0" > Scilab format .dat </option>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
63 <option value="1" selected="true" > HDF5 format .h5 </option>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
64 </param>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
65 <param name="filein" format="mat,h5,dat" type="data" label="MS data" />
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
66 <param name="signalthresh" size="5" value="0" type="integer" label="Baseline threshold" help="if not applied during the spectrum acquisition" />
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
67 <param name="type_sm" type="select" size="5" format="integer" label="Mode during spectrum acquisition" help="if centroid: 0 are removed; if profile: centroids are calculated" >
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
68 <option value="0" selected="true" > Centroid </option>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
69 <option value="1" > Profile mode with Orbitrap </option>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
70 </param>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
71 </inputs>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
72
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
73
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
74 <outputs>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
75 <data name="resbary" format="mat" label="MS-centroid" >
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
76 </data>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
77 </outputs>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
78
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
79
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
80 <tests>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
81
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
82 <test>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
83 <param name="format_io" value="0"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
84 <param name="filein" value="VI2016_AC_4Areduit_1.dat"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
85 <param name="signalthresh" value="0"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
86 <param name="type_sm" value="1"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
87 <output name="resbary" file="VI2016_AC_4Areduit_1centroide.mat" compare="sim_size" delta="2000" />
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
88 </test>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
89
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
90 <test>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
91 <param name="format_io" value="1"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
92 <param name="filein" value="VI2016_AC_4Areduit_1.h5"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
93 <param name="signalthresh" value="0"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
94 <param name="type_sm" value="1"/>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
95 <output name="resbary" file="VI2016_AC_4Areduit_1centroide.mat" compare="sim_size" delta="2000" />
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
96 </test>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
97
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
98 </tests>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
99
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
100
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
101 <help>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
102
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
103
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
104 **Author** Jean-Claude Boulet (INRAE).
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
105
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
106
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
107 ---------------------------------------------------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
108
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
109 ====================
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
110 CENTROID CALCULATION
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
111 ====================
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
112
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
113 -----------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
114 Description
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
115 -----------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
116
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
117
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
118 Centroids are calculated according to the reference cited below.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
119
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
120
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
121 ------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
122 Inputs
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
123 ------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
124
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
125 **MS format**
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
126
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
127 Two formats are possible: HDF5 obtained from Scilab (.dat) or HDF5 obtained from MSconvert then HDFView (.h5)
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
128
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
129 The Scilab format contains a structure with two fields:
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
130
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
131 - time: the retention times, a vector;
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
132
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
133 - mzdata: a list of same length as time; each element of the list is a matrix of two columns representing a MS1 mass spectrum: m/zvalues and associated signals.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
134
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
135 The HDF5 (.h5) file contains at least the following fields:
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
136
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
137 - ChomatogramTime: a vector containing the retention times of each mass spectrum.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
138
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
139 - ChromatogramIndex: the indexes of the signals identified in ChomatogramTime; the last value of ChromatogramIndex is the size of ChomatogramTime.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
140
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
141 - ChromatogramIntensity: the sum of intensities of the mass spectra associated to the RTs of ChomatogramTime; ChomatogramTime and ChromatogramIntensity are vectors of same length.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
142
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
143 - SpectrumIndex: a vecteur of integers corresponding to the numbers of signals of each MS in SpectrumMZ et SpectrumIntensity. For example, if the two first values of SpectrumIndex are 1421 and 2887, then the first MS is between 0 à 1421, the second between 1422 and 2887. The last value of spectrumIndex is the number of values in SpectrumMZ and in SpectrumIntensity.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
144
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
145 - SpectrumMz: the m/z values. For each mass spectrum, the first value is the real m/z value, but the following are obtained by the sum of the previous values. For example, if the three first values are: 220.0501, 0.1171 and 0.9856, then the real m/z values to be calculated will be: 220.0501, 220.1672=220.0501+0.1171, 220.2528=220.0501+0.1171+0.9856.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
146
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
147 - SpectrumIntensity: a vector containing all the intensities recorded.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
148
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
149 Even if the MS spectrum has been obtained with the centroid option of MSconvert, this function should be applied to remove all the zeros kept by the MSconcert peak picking option.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
150
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
151
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
152 **MS data**
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
153
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
154 The series of mass spectra
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
155
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
156
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
157 ----------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
158 Parameters
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
159 ----------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
160
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
161
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
162 **Baseline threshold**
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
163
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
164 Signals under the threshold are dropped. Default value = 0.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
165
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
166 Most of the peaks should be separated by regions with signal=0.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
167
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
168
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
169 **Mode during spectrum acquisition**
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
170
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
171 Profile or centroid.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
172
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
173
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
174
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
175 -------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
176 Outputs
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
177 -------
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
178
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
179 **centroid MS data**
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
180
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
181 For each RT, the signals associated to the same m/z value have been replaced by their centroid.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
182
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
183 The output is a structure with two fields:
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
184
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
185 - time: retention times;
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
186
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
187 - mzdata: m/z values and centroid signals.
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
188
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
189
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
190 </help>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
191
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
192
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
193 <citations>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
194
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
195 <citation type="bibtex">@article{sgcentroid,
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
196 title={High-resolution mass spectrometry (HRMS): focus on the m/z values estimated by the Savitzky-Golay first derivative},
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
197 author={Boulet, J.C. and Meudec, E. and Vallverdu-Queralt, A. and Cheynier, V.},
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
198 journal={Rapid Communications in Mass Spectrometry},
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
199 year={2020},
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
200 doi={10.1002/rcm.9036}
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
201 }
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
202 </citation>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
203
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
204 </citations>
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
205
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
206
5f444a41ee0a Uploaded
jcb-mpl
parents:
diff changeset
207 </tool>