annotate features_extract.xml @ 2:7e757edfa3b0 draft default tip

Deleted selected files
author jcb-mpl
date Thu, 12 May 2022 12:15:57 +0000
parents 247771a356a7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
1 <tool id="2021_05_features_extract" name="EICs -> Peaks:features" version="0.0.1">
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
2 <description> extracts the peaks (m/z x TR) from the EICs </description>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
3
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
4 <requirements>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
5 <requirement type="package" >scilab</requirement>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
6 </requirements>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
7
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
8
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
9 <stdio>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
10 <exit_code range="1:" level="fatal" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
11 </stdio>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
12
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
13
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
14 <command> <![CDATA[
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
15 $__root_dir__/packages/scilab-*/bin/scilab-cli -nb -quit -f ${script_file}
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
16 ]]>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
17 </command>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
18
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
19
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
20 <configfiles>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
21 <configfile name="script_file">
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
22 <![CDATA[ exec("$__tool_directory__/src/mz_8_peakpicking_dw.sci",-1); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
23 exec("$__tool_directory__/src/mz_6bis_durbin_watson.sci",-1); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
24 lasterror(); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
25 option=${option}; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
26 if option==1 then ... // liste ou fichier .dat
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
27 load("${list_eic4_files}"); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
28 list_var=who_user(%f); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
29 n=size(list_var,1); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
30 for i=1:n;
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
31 execstr(msprintf("type_tmp=type(%s);",list_var(i))); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
32 if type_tmp==15 then ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
33 execstr(msprintf("x_tr_mz4=%s;",list_var(i))); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
34 break;...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
35 end; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
36 end; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
37 ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
38 elseif option==2 then ... // tabular
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
39 x_tr_mz4=glx_tab2div("${list_eic4_files}"); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
40 end; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
41 ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
42 if isdef('x_tr_mz3'); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
43 x_tr_mz4=x_tr_mz3; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
44 end; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
45 ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
46 if typeof(x_tr_mz4)=="list"; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
47 x_tr_mz4_i=x_tr_mz4(${no}); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
48 elseif typeof(x_tr_mz4)=="div"; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
49 x_tr_mz4_i=x_tr_mz4; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
50 end; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
51 ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
52 [peaks_list,peaks_detail]=mz_8_peakpicking_dw(x_tr_mz4_i,[1:$],${plage_tr},${plage_min_tr},${dw_max},${signal_min},0); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
53 ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
54 peaks_list.i='eic n0 '+ peaks_list.i; ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
55 div2tab(peaks_list,"${peaks_list}"); ... // 20avril21
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
56 ... // save("${peaks_list}",'peaks_list'); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
57 save("${peaks_detail}",'peaks_detail'); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
58 ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
59 if ~isempty(lasterror(%f)); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
60 write(0,lasterror()); ...
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
61 end; ]]>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
62 </configfile>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
63 </configfiles>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
64
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
65
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
66 <inputs>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
67 <param name="list_eic4_files" format="mat,tabular" type="data" label="EICs files" help="a list of several files, or a single matrix EIC matrix (RT x m/z)" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
68 <param name="option" value="2" type="integer" min="1" max="2" label="Type of data" help="1= a list from the function: EIVs -> check reference mz; 2= an EIC matrix, e.g. from the function: EICs-synchronized -> EICs-merged" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
69 <param name="no" size="5" value="1" type="integer" label="Number" help="if list, from 1 to 5 " />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
70 <param name="plage_tr" size="5" value="0.3" type="float" label="Maximum range of RT " help="in minutes" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
71 <param name="plage_min_tr" size="5" value="0.05" type="float" label="Minimum range of RT " help="in minutes" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
72 <param name="dw_max" size="5" value="1" type="float" label="Threshold for Durbin-Watson" help="a value between 0 and 2" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
73 <param name="signal_min" size="5" value="100000" type="float" label="Threshold for the signal max" help="peaks with signal max under this value are dropped" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
74
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
75 </inputs>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
76
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
77
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
78 <outputs>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
79 <data name="peaks_list" format="tabular" label="Peaks list"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
80 <data name="peaks_detail" format="mat" label="Peaks details" />
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
81 </outputs>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
82
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
83
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
84 <tests>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
85
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
86 <test>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
87 <param name="list_eic4_files" value="x4_list.dat"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
88 <param name="option" value="1"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
89 <param name="no" value="3"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
90 <param name="plage_tr" value="0.3"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
91 <param name="plage_min_tr" value="0.05"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
92 <param name="dw_max" value="1"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
93 <param name="signal_min" value="100000"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
94 <output name="peaks_list">
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
95 <assert_contents>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
96 <has_text text="0.2020"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
97 <has_text text="0.8740"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
98 <has_text text="3.2942"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
99 </assert_contents>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
100 </output>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
101 </test>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
102
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
103 <test>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
104 <param name="list_eic4_files" value="x4.tab"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
105 <param name="option" value="2"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
106 <param name="plage_tr" value="0.3"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
107 <param name="plage_min_tr" value="0.05"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
108 <param name="dw_max" value="1"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
109 <param name="signal_min" value="100000"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
110 <output name="peaks_list">
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
111 <assert_contents>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
112 <has_text text="0.2020"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
113 <has_text text="0.8740"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
114 <has_text text="3.2942"/>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
115 </assert_contents>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
116 </output>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
117 </test>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
118
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
119 </tests>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
120
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
121
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
122 <help>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
123
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
124
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
125 **Authors** Jean-Claude Boulet (INRA).
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
126
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
127
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
128 ---------------------------------------------------
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
129
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
130 =========================
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
131 PEAKS:FEATURES EXTRACTION
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
132 =========================
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
133
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
134 -----------
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
135 Description
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
136 -----------
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
137
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
138 A feature or peak is a signal recorded for a given m/z value and a range of retention times.
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
139
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
140 This function extracts the peaks of each EIC from an EIC matrix.
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
141
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
142 Note: this features extraction algorithm does not claim novelty nor higher performances. But it corresponds well to our outputs. For a basic use.
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
143
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
144
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
145
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
146 -----
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
147 Input
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
148 -----
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
149
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
150 **EICs files**
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
151
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
152 - a matrix from e.g. the function: EICs-synchronized -> EICs-merged
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
153
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
154 - or a list yielded by the function: EICs -> checks reference mz
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
155
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
156
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
157 ----------
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
158 Parameters
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
159 ----------
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
160
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
161 **Number**
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
162
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
163 In case of a list, the number to select, from 1 to 5, corresponding to the m/z thresholds of 0.0005, 0.0010, 0.0030, 0.0050 and 0.0100 respectively
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
164
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
165 **Maximum range of retention time**
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
166
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
167 Default value: 0.3
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
168
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
169
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
170 **Minimum range of retention time**
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
171
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
172 Default value: 0.05
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
173
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
174 **Threshold for Durbin-Watson**
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
175
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
176 Default value: 1
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
177
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
178
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
179 -------
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
180 Outputs
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
181 -------
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
182
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
183 **Peaks list**
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
184
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
185 A file of 4 columns: RT min, RT max, m/z value and signal
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
186
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
187 **Peaks detail**
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
188
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
189 The file, format HDF5-scilab, contains a list.
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
190
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
191 Each element of the list is associated to a peak, i.e. a line of the Peaks List output.
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
192
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
193 Each element of the list contains a column vector of the signals recorded along a range of retention times, identified by the line labels. The column label is the m/z value of the peak.
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
194
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
195 </help>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
196
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
197
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
198 <citations>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
199
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
200 </citations>
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
201
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
202
247771a356a7 Uploaded
jcb-mpl
parents:
diff changeset
203 </tool>