annotate format_versionning.MD @ 0:1660665c081e draft

#issue9 branch Updating - - Fxx
author fgiacomoni
date Thu, 19 Nov 2020 14:28:46 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
1
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
2 INTRODUCTION
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
3 =====
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
4 This file describes the format of the database generated by XSeeker
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
5 Preprocessor. This format will evolve in the future to fit users
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
6 wanted features. That's why there is a history of versions numbers,
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
7 describing what they brought to the sqlite file, and how it was usefull.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
8
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
9 The first version (the older one) is at the bottom of this file, and the
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
10 modifications provided by the newest versions are on top of the file.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
11
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
12
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
13 VERSION 1.1.2
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
14 =====
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
15 add missing mz_tab_info$group_length field to produce mzTab
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
16
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
17 VERSION 1.1.1
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
18 =====
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
19 add missing mz_tab_info$dataset_path field to produce mzTab
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
20
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
21
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
22 VERSION 1.1.0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
23 =====
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
24 Summary:
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
25 - The field `mz_tab_info` was added in new table smol_xcms_set.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
26
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
27 smol_xcms_set table added
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
28 -----
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
29 This table contains a subset of the original ms file.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
30
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
31 mz_tab_info field added to smol_xcms_set
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
32 -----
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
33 This field contains five subfields:
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
34 - sampclass ;
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
35 - sampnames ;
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
36 - rtmed ;
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
37 - mzmed ;
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
38 - smallmolecule_abundance_assay .
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
39
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
40 These fields were added after users asked to export data from XSeeker
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
41 in mzTab files.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
42 XCMS has some functions to extract sampclass, sampnames, rtmed, mzmed
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
43 and smallmolecule_abundance_assay from xcms set. Then, they are used
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
44 in the mz tab creation process, but we didn't want to keep the whole
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
45 xcmsset object. So we used the original code from XCMS and modified it
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
46 a little bit, justifying the extraction of these new fields.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
47
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
48
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
49 VERSION 1.0.0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
50 =====
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
51
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
52
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
53 DATABASE
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
54 -----
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
55
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
56 ### SAMPLE
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
57
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
58 #### RAW
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
59 This structure is an epurated and enriched version of the original
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
60 rdata, saved as a compressed env:
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
61 `blob::blob(fst::compress_fst(serialize(raw, NULL), compression=100))`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
62
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
63 The fields contained in the env are as follow:
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
64
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
65 ##### variableMetadata
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
66
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
67 ##### tic
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
68
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
69 ##### mz
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
70
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
71 ##### scanindex
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
72
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
73 ##### scantime
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
74
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
75 ##### intensity
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
76
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
77 ##### polarity
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
78
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
79 ##### sample_name
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
80
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
81 ##### dataset_path
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
82
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
83 ##### process_params
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
84
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
85 ##### enriched_rdata
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
86
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
87 ##### enriched_rdata_version
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
88
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
89 ##### tool_name
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
90
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
91 ##### enriched_rdata_doc