annotate config.yml @ 1:7e3085fc60c1 draft default tip

master branch Updating
author lain
date Wed, 30 Aug 2023 14:21:18 +0000
parents b58b229c4cbf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
1 ##
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
2 ## when you see {{ something }} in a string, this means the string is
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
3 ## a template, and the "{{ something }}" will be replaced by its value
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
4 ## at runtime.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
5 ## This is usefull to build strings from other strings.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
6 ## to reference an item in a tree, you can use dots as branches:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
7 ## {{ parameters.flags.help }}
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
8 ## will be extrapolated to "Show this help"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
9 ##
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
10 ## But beware:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
11 ## {{ parameters.mandatory }}
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
12 ## will be extrapolated to
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
13 ## "{'input': 'input file path'}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
14 ##
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
15
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
16 ## this config is used for debug.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
17 ## it allows to define debug options before everything else is parsed
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
18 __meta_config__:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
19 __debug__: False
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
20 __debug_stream__: stderr
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
21 __only_root_debug__: False
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
22
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
23
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
24 ## the cli parameters
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
25 parameters:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
26 mandatory:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
27 ## input is mandatory
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
28 input: input file path
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
29 flags:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
30 ## help, verbose and version can be provided with no parameter.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
31 help: Show this help
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
32 verbose: More verbose outputs
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
33 version: Show this tool's version
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
34 debug: show debug outputs
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
35 do_run_dry: Runs the whole process, without the server. Usefull for tests.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
36 embed_js: Embed js in html file instead of using a separated js file.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
37 firefox: Open firefox on the web page.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
38 chromium: Open chromium or chrome on the web page.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
39 optional:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
40 ## these optional parameters need a value "--opt value --opt2 value2"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
41 method: "default is {{ defaults.method }}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
42 spectrum_type: "default is {{ defaults.spectrum_type }}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
43 sample_type: "default is {{ defaults.sample_type }}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
44 resolution: "default is {{ defaults.resolution }}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
45 name: The precursor name
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
46 peakforest.url: "default={{ defaults.peakforest.url }}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
47 peakforest.token: The token to comunicate with peakforest api
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
48 polarity: positive|negative
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
49 raw_metadata: example - 1-1__INCHIKEY__=QNAYBMKLOCPYGJ-REOHCLBHSA-N_L-Alanine_MS_POS_plasma_RT__=0.84_filtree.csv
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
50 scan_type: ms|msms|rmn
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
51 rt_min: Min retention time
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
52 rt_max: Max retention time
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
53 run_dry_html: when "--run-dry", provides the output directory for {{ generated.html }}
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
54 run_dry_js: when "--run-dry", provides the output directory for {{ generated.js }}
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
55 raw_metadata_sep: "raw metadata separator"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
56 logging.std: "Either out, err, or anything else to not output"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
57 logging.file.path: "The file path to output logs to"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
58 validation: "Set the default validation to the provided value, TRUE or FALSE."
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
59 output_json: "Provide a path to output a JSON file."
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
60 pid: "Path to the pid file"
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
61 ip: "the net intf to link to"
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
62 port: "the net port to bind on"
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
63 meta:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
64 ## meta info about the tool itself
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
65 author: Lain Pavot
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
66 version: 1.2.1
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
67 shortcuts:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
68 ## to define things like: "we can use -p instead of --polarity"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
69 peakforest.token: t
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
70 polarity: p
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
71 help: h
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
72 version: v
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
73 verbose: V
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
74 debug: d
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
75 logging.std: l
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
76
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
77 ## some default parameters
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
78 ## logging defines two elements: std and file.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
79 ## std should be either empty, err or out.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
80 ## it tells where to outputs logs:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
81 ## - nowhere (empty value)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
82 ## - in sterr (err)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
83 ## - in stdout (out)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
84 ## and file. Id a path is provided, add outputs to this file.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
85 ## if append is true, outputs are appended to the file.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
86 ## otherwise, the file is emptied each time the app runs.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
87 defaults:
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
88 ip: 0.0.0.0
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
89 port: 8000
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
90 peakforest:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
91 url: https://nightly.peakforest.org
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
92 token: ''
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
93 spectrum_type: LC_MSMS
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
94 method: cf_pfem_urine_method1_qtof-msms
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
95 # api-msms-fia__idf-cea
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
96 # cf_pfem_plasma_method1_qtof-msms
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
97 # cf_pfem_urine_method1_qtof-msms
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
98 # lc-msms__test
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
99 scan_type: ms2
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
100 resolution: high
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
101 sample_type: compound-ref
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
102 # sample_type: compound-mix
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
103 polarity: positive
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
104 raw_metadata: ''
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
105 name: ''
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
106 run_dry_html:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
107 run_dry_js:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
108 raw_metadata_sep: ','
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
109 validation: "TRUE"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
110 verbose: false
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
111 debug: true
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
112 logging:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
113 std: out ## out || err
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
114 file:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
115 path:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
116 append: False
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
117 output_json: ''
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
118 rt_min: 0.9
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
119 rt_max: 1.9
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
120 pid:
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
121
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
122 ## token related info
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
123 token:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
124 ## do you use a file to store your token?
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
125 use_file: false
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
126 ## if so, what path the file is located at?
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
127 file_path: .token
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
128 ## if not, you can provide you token here
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
129 value:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
130
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
131 workdir:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
132 ## create a tmp directory
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
133 create_tmp: true
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
134 ## works in the created tmp directory, or if not created, in /tmp
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
135 work_in_tmp: true
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
136 ## generate outputs in the created tmp directory, or if not created, in /tmp
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
137 generate_in_tmp: true
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
138
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
139 ## the templates paths
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
140 templates:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
141 ## meta is what wrapps the whole page.
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
142 main: src/meta.html
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
143 main_mix: src/meta-compound-mix.html
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
144 main_ref: src/meta-compound-ref.html
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
145 ## form is one instance of a pf form
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
146 # form: src/form.html
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
147 # form: src/compound-ref.html
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
148 form: src/form.html
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
149 form_mix: src/compound-mix.html
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
150 form_ref: src/compound-ref.html
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
151 ## one item of the tab list
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
152 tab_list: src/tab_list.html
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
153 ## the js for one form
1
7e3085fc60c1 master branch Updating
lain
parents: 0
diff changeset
154 js: src/add-one-spectrum-index.js
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
155 ## placeholders for the html templates.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
156 ## this will not change the placeholders syntax for this file.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
157 placeholders:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
158 start: "{{ "
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
159 stop: " }}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
160
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
161 generated:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
162 ## what filename to give to the whole html file
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
163 html: pf.html
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
164 ## what filename to give to js files
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
165 js: add-one-spectrum-{{ index }}.js
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
166
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
167 regex:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
168 values:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
169 ## reuse these smol regex in bigger regex!
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
170 spectrum_type: "NMR|LC_MS|LC_MSMS|MRM(_\\d+)?"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
171 matrix: "[Uu]rine|[Pp]lasma|[Pp]las"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
172 mode: "POS|NEG"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
173 energy: "\\d+ev"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
174 pool: "[Pp]ool\\d+"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
175 rt: "\\d+\\.\\d+"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
176 runs: "\\d+-\\d+"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
177 inchikey: "[A-Z]{14}-[A-Z]{10}-[A-Z]"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
178
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
179 ## the "INCHIKEY" word
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
180 ## one or more underscores
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
181 ## may be followed by a equal sign
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
182 ## captures in the "inchikey" variable:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
183 ## 14, 10 and 1 letters
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
184 ## in caps
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
185 ## separated by a hyphen
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
186 inchikey: "INCHIKEY_+=?(?P<inchikey>{{ regex.values.inchikey }})"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
187
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
188 ## method is one of values defined bellow, between underscores
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
189 spectrum_type: "_(?P<method>{{ regex.values.method }})_"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
190
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
191 ## matrix is one of values defined bellow, between underscores
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
192 matrix: "_(?P<matrix>{{ regex.values.matrix }})_"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
193
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
194 ## pool is one of values defined bellow, between underscores
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
195 pool: "_(?P<pool>{{ regex.values.pool }})_"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
196
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
197 ## molecule everything between inchikey and method.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
198 molecule: "{{ regex.inchikey }}_(?P<molecule>.*?){{ regex.method }}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
199
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
200 ## mode is one of values defined bellow, between underscores
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
201 mode: "_(?P<mode>{{ regex.values.mode }})_"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
202
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
203 ## energy is one of values defined bellow, between underscores
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
204 energy: "_(?P<energy>{{ regex.values.energy }})_"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
205
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
206 ## - A underscore,
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
207 ## - the "RT" word,
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
208 ## - some underscore(s),
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
209 ## - an optional interrogation mark,
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
210 ## - the actual RT value is captured here,
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
211 ## - there is a underscore at the end
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
212 rt: "_RT_+=?(?P<rt>{{ regex.values.rt }})_"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
213
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
214 ## "runs" is at the beginning, and ends with an underscore.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
215 runs: "^(?P<runs>{{ regex.values.runs }})_"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
216
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
217
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
218 ## BEGIN
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
219 ## anything
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
220 ## the inchikey
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
221 ## anything else can follow
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
222 ## END
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
223 # fragnot: ^.*{{ regex.inchikey }}.*$
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
224
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
225
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
226 ## This is the most exhaustive regex I came with to extract info from
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
227 ## fragnot files name.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
228 # fragnot:
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
229 # ^
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
230 # .* (?# there may be anything at the begining)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
231 # (?P<runs>\d+-\d+) (?# the run numbers)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
232 # _+ (?# followed by anything - underscores usualy)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
233 # INCHIKEY_+=?(?P<inchikey>{{ regex.inchikey }}) (?# we insert inchikey regex here - see above)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
234 # _+ (?# there is one or more underscores)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
235 # (?P<molecule>.*?) (?# the molecule name follows the inchikey)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
236 # _+ (?# there is one or more underscores)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
237 # (?P<method>{{ regex.method }}) (?# then, there is the method - nmr, ms or mrm???)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
238 # _+ (?# there may be some underscores to separate)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
239 # (?P<matrix>{{ regex.matrix }})? (?# the matrix - urine or plasma)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
240 # _* (?# there may be some underscores to separate)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
241 # (?P<mode>POS|NEG) (?# the acq mode - pos or neg)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
242 # _+ (?# there may be some underscores to separate)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
243 # (?P<pool>{{ regex.pool }})? (?# the pool - "Pool"+numbers, optional)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
244 # _* (?# there may be some underscores to separate)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
245 # (?P<energy>\d+ev)? (?# the energy - only for nmr, so it's optional)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
246 # _* (?# there may be some underscores to separate)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
247 # (?P<pool2>{{ regex.pool }})? (?# the pool - sometimes the pool if *after* the energy...)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
248 # _* (?# there may be some underscores to separate)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
249 # (?P<matrix2>{{ regex.matrix }})? (?# the matrix is here, sometimes)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
250 # _* (?# there may be anything here)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
251 # RT_+=?(?P<rt>\d+\.\d+) (?# the retension time is a decimal number)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
252 # _* (?# there may be anything at the end)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
253 # (?P<filtered>[fF]iltree)? (?# sometimes, "Filtree" appears, lets capture it)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
254 # \.[ct]sv (?# the extension)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
255 # $