annotate format_versionning.MD @ 19:2937e72e5891 draft

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