/
data_structures.html
316 lines (291 loc) · 11.5 KB
/
data_structures.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>A guide to eegUtils data structures • eegUtils</title>
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script><meta property="og:title" content="A guide to eegUtils data structures">
<meta property="og:description" content="eegUtils">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#toc">
<div class="container template-article">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">eegUtils</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.1</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../articles/eegUtils.html">Get started</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/data_structures.html">A guide to eegUtils data structures</a>
</li>
<li>
<a href="../articles/epoch-handling.html">Event and epoch handling</a>
</li>
<li>
<a href="../articles/linear_modelling/linear_modelling.html">Linear Modelling</a>
</li>
<li>
<a href="../articles/time-frequency-analysis.html">Frequency analysis</a>
</li>
<li>
<a href="../articles/topoplot/topoplot.html">Building a topographical plot</a>
</li>
</ul>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/craddm/eegUtils/">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div>
<!--/.nav-collapse -->
</div>
<!--/.container -->
</div>
<!--/.navbar -->
</header><script src="data_structures_files/header-attrs-2.7/header-attrs.js"></script><div class="row">
<div class="col-md-9 contents">
<div class="page-header toc-ignore">
<h1 data-toc-skip>A guide to eegUtils data structures</h1>
<h4 class="author">Matt Craddock</h4>
<h4 class="date">2021-02-22</h4>
<small class="dont-index">Source: <a href="https://github.com/craddm/eegUtils/blob/master/vignettes/data_structures.Rmd"><code>vignettes/data_structures.Rmd</code></a></small>
<div class="hidden name"><code>data_structures.Rmd</code></div>
</div>
<div id="eegutils" class="section level2">
<h2 class="hasAnchor">
<a href="#eegutils" class="anchor"></a>eegUtils</h2>
<p><code>eegUtils</code> uses S3 objects to store EEG data and associated information such as channel locations. Using different object classes for data structured in different ways ensures that the various plotting functions work consistently across different types of EEG data. For example, there are different classes for epoched (<code>eeg_epochs</code>) and continuous data (<code>eeg_data</code>), and for time-frequency representations of data (<code>eeg_tfr</code>).</p>
</div>
<div id="eeg_data-objects" class="section level2">
<h2 class="hasAnchor">
<a href="#eeg_data-objects" class="anchor"></a><code>eeg_data</code> objects</h2>
<p><code>eeg_data</code> objects are the base class used for continuous data. When raw data is imported, the output is this class. Currently, this class is a list constituting the following entries:</p>
<ul>
<li>
<code>signals</code>
<ul>
<li>A data frame containing the actual EEG data in wide format. Each column is data from a single electrode, each row from a single timepoint.</li>
</ul>
</li>
<li>
<code>srate</code>
<ul>
<li>A single integer giving the sampling rate of the data in Hz</li>
</ul>
</li>
<li>
<code>events</code>
<ul>
<li>A data.frame/tibble with 3 columns describing the events recorded in the data.
<ul>
<li>event_onset (in samples) relative to <em>recording onset</em>
</li>
<li>event_time (in seconds) relative to <em>recording onset</em>
</li>
<li>event_type (typically integer, others possible)</li>
</ul>
</li>
</ul>
</li>
<li>
<code>chan_info</code>
<ul>
<li>Often NULL on import, since BDF and CNT do not contain (useable) electrode locations.</li>
<li>A data.frame/tibble containing channel location information can be added. Currently similar to EEGLAB style, with the following columns (may change):
<ul>
<li>
<code>electrode</code> - electrode names</li>
<li>
<code>radius</code> - Spherical co-ordinates (Radius is typically normalized to 1)</li>
<li>
<code>theta</code> - Spherical co-ordinates (theta)</li>
<li>
<code>phi</code> - Spherical co-ordinates (theta)</li>
<li>
<code>cart_x</code> - Cartesian 3D coordinates</li>
<li>
<code>cart_y</code> - Cartesian 3D coordinates</li>
<li>
<code>cart_z</code> - Cartesian 3D coordinates</li>
<li>
<code>x</code> - 2D Stereographic projection of the spherical coordinates</li>
<li>
<code>y</code> - 2D Stereographic projection of the spherical coordinates</li>
</ul>
</li>
</ul>
</li>
<li>
<code>timings</code>
<ul>
<li>A data.frame containing a description of each row in time (s) and sample numbers (samples)</li>
</ul>
</li>
<li>
<code>epochs</code>
<ul>
<li>A data.frame containing information about the epochs in the data, more relevant for epoched data</li>
</ul>
</li>
<li>
<code>reference</code>
<ul>
<li>NA on loading, in the absence of a recorded reference channel.</li>
<li>Once data is referenced, is a list consisting of two entries.
<ul>
<li>
<code>ref_chans</code> - Labels for channels used to calculate the reference data. Can also be “average”.</li>
<li>
<code>excluded</code> - Labels for any channels excluded from the reference data.</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div id="eeg_epochs" class="section level2">
<h2 class="hasAnchor">
<a href="#eeg_epochs" class="anchor"></a>eeg_epochs</h2>
<p><code>eeg_epochs</code> objects share the same overall structure with <code>eeg_data</code> objects, but some of the internals currently differ, as described below.</p>
<ul>
<li>
<code>events</code>
<ul>
<li>The events table has two additional columns, <code>epoch</code> and <code>time</code>.
<ul>
<li>
<code>epoch</code> gives the epoch number to which a given event belongs</li>
<li>
<code>time</code> gives the time point at which the event occurs relative to the <em>epoch onset</em>
</li>
<li>
<code>event_time</code> still gives the time point at which the event occurs relative to the <em>recording onset</em>
</li>
</ul>
</li>
</ul>
</li>
<li>
<code>timings</code>
<ul>
<li>The timings table has one additional column, <code>epoch</code>.
<ul>
<li>
<code>epoch</code> gives the epoch number to which a given datapoint belongs</li>
<li>
<code>sample</code> still uniquely identifies each datapoint</li>
<li>
<code>time</code> now gives the time relative to the zero-point of the epoch, i.e. the <em>event</em> on which the epoch is centred.</li>
</ul>
</li>
</ul>
</li>
<li>
<code>epochs</code>
<ul>
<li>A data.frame containing information about the participant, and labels applied to any epochs</li>
</ul>
</li>
</ul>
</div>
<div id="eeg_tfr" class="section level2">
<h2 class="hasAnchor">
<a href="#eeg_tfr" class="anchor"></a>eeg_tfr</h2>
<p><code>eeg_tfr</code> objects hold time-frequency representations of <code>eeg_epochs</code> objects.</p>
<ul>
<li>
<code>signals</code>
<ul>
<li>a 4D matrix - time by electrode by frequency by epoch</li>
</ul>
</li>
<li>
<code>dimensions</code>
<ul>
<li>keeps track of which matrix dimension corresponds to which property.</li>
</ul>
</li>
</ul>
</div>
<div id="eeg_ica" class="section level2">
<h2 class="hasAnchor">
<a href="#eeg_ica" class="anchor"></a>eeg_ICA</h2>
<p><code>eeg_ICA</code> objects contain the results of an ICA decomposition applied to an <code>eeg_epochs</code> object.</p>
<ul>
<li>
<code>mixing_matrix</code>
<ul>
<li>The weights that are used to convert the source data into the original data</li>
</ul>
</li>
<li>
<code>unmixing_matrix</code>
<ul>
<li>The weights that are used to convert the original data into source data</li>
</ul>
</li>
<li>
<code>signals</code> - individual component activations</li>
</ul>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc"><h2 data-toc-skip>Contents</h2>
</nav>
</div>
</div>
<footer><div class="copyright">
<p>Developed by Matt Craddock.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
</div>
</footer>
</div>
</body>
</html>