annotate features_check_references.xml @ 2:edc94aa0b5c4 draft default tip

Deleted selected files
author jcb-mpl
date Thu, 12 May 2022 12:15:16 +0000
parents c1008b92a6c8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
1 <tool id="2021_05_features_check_references" name="Features -> checks references" version="0.0.1">
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
2
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
3 <description> </description>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
4
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
5 <requirements>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
6 <requirement type="package" >scilab</requirement>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
7 </requirements>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
8
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
9
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
10 <stdio>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
11 <exit_code range="1:" level="fatal" />
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
12 </stdio>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
13
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
14
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
15 <command>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
16 <![CDATA[
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
17 $__root_dir__/packages/scilab-*/bin/scilab-cli -nb -quit -f ${script_file}
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
18 ]]>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
19 </command>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
20
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
21
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
22 <configfiles>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
23 <configfile name="script_file">
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
24 <![CDATA[ exec("$__tool_directory__/src/mz_9_compares_peaks.sci",-1); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
25 lasterror(); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
26 ... //load "${peaks_list}"; ... // 22avril21
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
27 peaks_list=glx_tab2div("${peaks_list}"); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
28 ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
29 load "${peaks_detail}"; ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
30 x836=glx_tab2div("${peaks_reference}"); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
31 diff_mz=${diff_mz}; ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
32 k=${k}; ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
33 x_peaks_final=mz_9_compares_peaks(peaks_list,peaks_detail,x836,diff_mz,k); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
34 ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
35 div2tab(x_peaks_final,"${x_peaks_final}"); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
36 if ~isempty(lasterror(%f)); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
37 write(0,lasterror()); ...
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
38 end; ]]>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
39 </configfile>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
40 </configfiles>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
41
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
42
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
43 <inputs>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
44 <param name="peaks_list" format="tabular" type="data" label="Features list" help="from function EIC->peaks:features" />
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
45 <param name="peaks_detail" format="mat" type="data" label="Detailed features" help="from function EIC->peaks:features" />
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
46 <param name="peaks_reference" format="tabular" type="data" label="Reference features" help="2columns: mz and RT, with column and line headers" />
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
47 <param name="diff_mz" value="0.0050" type="float" label="Threshold for m/z values" />
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
48 <param name="k" value="1" type="integer" label="Number of extracted features for each reference feature" help="the closest to the reference peak" />
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
49
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
50 </inputs>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
51
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
52
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
53 <outputs>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
54 <data name="x_peaks_final" format="tabular" label="Identified features" />
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
55 </outputs>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
56
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
57
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
58 <tests>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
59
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
60 <test>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
61 <param name="peaks_list" value="Peaks_list.tabular"/>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
62 <param name="peaks_detail" value="Peaks_details.mat"/>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
63 <param name="peaks_reference" value="ref_mz_rt.tab"/>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
64 <param name="diff_mz" value="0.0050"/>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
65 <param name="k" value="1"/>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
66 <output name="x_peaks_final">
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
67 <assert_contents>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
68 <has_text text="136.0616"/>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
69 <has_text text="229.135"/>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
70 </assert_contents>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
71 </output>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
72 </test>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
73
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
74 </tests>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
75
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
76
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
77 <help>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
78
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
79
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
80 **Author** Jean-Claude Boulet (INRA).
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
81
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
82
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
83 ---------------------------------------------------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
84
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
85 ==================================
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
86 FEATURES EXPERIMENTAL VS REFERENCE
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
87 ==================================
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
88
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
89
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
90 -----------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
91 Description
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
92 -----------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
93
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
94 This function checks reference features among experimental features.
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
95
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
96 -----------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
97 Input files
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
98 -----------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
99
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
100 **Features list**
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
101
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
102 The tabular file yielded by the function: EICs -> peaks:features
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
103
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
104
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
105 **Detailed features**
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
106
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
107 The HDF5-scilab file yielded by the function: EICs -> peaks:features
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
108
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
109
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
110 **Reference features**
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
111
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
112 A tabular file containing 2 columns: m/z values then retention times
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
113
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
114 Row labels are the names of the reference features, e.g. chemical compounds
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
115
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
116
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
117
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
118 ----------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
119 Parameters
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
120 ----------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
121
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
122 **Threshold for m/z values**
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
123
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
124 Observed features are associated to the reference features if 1) the difference in m/z values is under the threshold; 2) the reference RT falls within the range of the observed RTs.
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
125
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
126 Default: 0.0050
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
127
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
128 **Number of extracted features for each reference feature**
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
129
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
130 e.g. if the number is 2, the algorithm will extract the 2 experimental features closest to each reference feature.
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
131
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
132
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
133 ------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
134 Output
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
135 ------
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
136
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
137
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
138 **Identified features**
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
139
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
140 A tabular file with the columns:
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
141
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
142 - name of the reference feature
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
143
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
144 - number of the reference feature in the input file: Reference features
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
145
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
146 - number of the experimental feature in the input files: Features List and Detailed features
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
147
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
148 - number of identifications= the number of reference features each experimental feature has been attributed to; target = 1
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
149
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
150 - m/z value of the reference feature
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
151
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
152 - m/z value of the experimental feature
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
153
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
154 - difference of m/z values
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
155
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
156 - RT of the reference feature
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
157
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
158 - RT of the experimental feature
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
159
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
160 - difference of RT
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
161
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
162 - signal of the experimental feature
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
163
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
164
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
165 </help>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
166
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
167
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
168 <citations>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
169
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
170 </citations>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
171
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
172
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
173 </tool>
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
174
c1008b92a6c8 Uploaded
jcb-mpl
parents:
diff changeset
175