/
index.html
734 lines (689 loc) · 35.7 KB
/
index.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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<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>Changelog • 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="Changelog" />
<!-- 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-news">
<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>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1 data-toc-skip>Changelog <small></small></h1>
<small>Source: <a href='https://github.com/craddm/eegUtils/blob/master/NEWS.md'><code>NEWS.md</code></a></small>
</div>
<div id="eegutils-0609999" class="section level1">
<h1 class="page-header" data-toc-text="0.6.0.9999">
<a href="#eegutils-0609999" class="anchor"></a>eegUtils 0.6.0.9999</h1>
<div id="function-changes" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code>ar_eogcor</code> now has a <code>bipolarize</code> argument which can be set to false when the HEOG/VEOG channels are already bipolarized.</li>
<li>added some new <code>ggplot2</code> based functions for topoplotting and adding contours
<ul>
<li><code><a href="../reference/stat_scalpcontours.html">stat_scalpcontours()</a></code></li>
</ul>
</li>
<li>
<code><a href="../reference/geom_topo.html">geom_topo()</a></code> now has contours</li>
<li>added errors with when attempting to use <code>compute_psd</code> or <code>compute_tfr</code> on <code>eeg_group</code> objects.</li>
</ul>
</div>
<div id="internal-changes--bug-fixes" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes--bug-fixes" class="anchor"></a>Internal changes / bug fixes</h3>
<ul>
<li>
<code>eeg_reference</code> now handles multiple reference channels better on rereferencing</li>
<li>
<code>get_scalpmap</code> handles <code>eeg_ICA</code> components better when there are channels with no locations</li>
<li>Travis-CI removed.</li>
<li>
<code>cart_to_spherical</code> coord flipping bug fixed (hopefully…)</li>
<li>
<code>filter</code> now converts to tibble internally and does not coerce <code>signals</code> to a vector when there is only one channel.</li>
<li>added copyright info to <code>summary_contour</code> file</li>
</ul>
</div>
</div>
<div id="eegutils-060" class="section level1">
<h1 class="page-header" data-toc-text="0.6.0">
<a href="#eegutils-060" class="anchor"></a>eegUtils 0.6.0</h1>
<p>IMPORTANT: There have been some changes to the logic of the <code><a href="../reference/topoplot.html">topoplot()</a></code> that may make their appearance quite different. Specifically, these changes are to the way the underlying interpolation grid is calculated and to how things like the diameter of the cartoon head is calculated. These changes often lead to different minimum or maximum amplitudes across the image, and thus changes in the appearance of the plot due to different scales- don’t be alarmed!</p>
<div id="function-changes-1" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-1" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code>epoch_data</code> baseline correction now defaults to <em>no</em> baseline correction</li>
<li>Added <code>filter</code> method for <code>eeg_tfr</code> objects</li>
<li>
<code><a href="../reference/fit_glm.html">fit_glm()</a></code> overhauled. Now far faster and allows specification of models using standard R formulae.</li>
<li>New <code>eeg_lm</code> class introduced for output of <code><a href="../reference/fit_glm.html">fit_glm()</a></code>.</li>
<li>
<code><a href="../reference/plot_butterfly.html">plot_butterfly.eeg_lm()</a></code> method added</li>
<li>
<code><a href="https://rdrr.io/r/base/as.data.frame.html">as.data.frame()</a></code> methods have been added for <code>eeg_lm</code> objects.</li>
<li>
<code><a href="../reference/view_ica.html">view_ica()</a></code> Shiny viewer for <code>eeg_ICA</code> and <code>eeg_decomp</code> objects added.</li>
<li>
<code><a href="../reference/view_artefacts.html">view_artefacts()</a></code>Shiny viewer for channel and epoch stats added.</li>
<li>
<code><a href="../reference/plot_timecourse.html">plot_timecourse()</a></code> now takes a mapping argument, which allows use of <code>ggplot2</code> <code><a href="https://ggplot2.tidyverse.org/reference/aes.html">aes()</a></code> mappings</li>
<li>
<code><a href="../reference/eeg_average.html">eeg_average.eeg_tfr()</a></code> now follows behaviour of other <code><a href="../reference/eeg_average.html">eeg_average()</a></code> methods in respecting the <code>epochs</code> structure.<br>
</li>
<li>
<code><a href="../reference/compute_itc.html">compute_itc()</a></code> added for computing inter-trial coherence from <code>eeg_tfr</code> objects.</li>
<li>
<code>cols</code> added to <code>eeg_average.eeg_tfr</code>
</li>
<li>
<code>eeg_combine.tfr_average()</code> added to handle pre-averaged <code>eeg_tfr</code> objects</li>
<li>
<code><a href="../reference/compute_tfr.html">compute_tfr()</a></code> now allows non-constant number of cycles</li>
<li>
<code><a href="../reference/compute_tfr.html">compute_tfr()</a></code> now uses a different scaling factor, so raw units should now be microvolts-squared.</li>
<li>added <code><a href="../reference/import_erplab.html">import_erplab()</a></code> function</li>
<li>
<code><a href="../reference/plot_timecourse.html">plot_timecourse()</a></code> now allows CIs for <code>eeg_group</code> objects.</li>
</ul>
</div>
<div id="internal-changes--bug-fixes-1" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes--bug-fixes-1" class="anchor"></a>Internal changes / bug fixes</h3>
<ul>
<li>
<code><a href="../reference/plot_tfr.html">plot_tfr()</a></code> now always drops NA/NaN values and averages appropriately over electrodes and conditions.</li>
<li>
<code><a href="../reference/import_set.html">import_set()</a></code> handles continuous EEG data from EEGLAB much better</li>
<li>Now using <code>whitening</code> package for whitening before SOBI ICA</li>
<li>
<code>select_epochs</code> for <code>eeg_ICA</code> objects fixed to correctly remove epochs from <code>signals</code>
</li>
<li>added tests for <code>filter.eeg_ICA</code> and <code>filter.eeg_tfr</code>
</li>
<li>fixed <code>filter.eeg_data</code> and <code>filter.eeg_evoked</code>
</li>
<li>
<code>select_elecs</code> for <code>eeg_ICA</code> now correctly removes components from the unmixing matrix</li>
<li>switched back to using <code>left_join</code> from <code>dplyr</code> in the <code>tag_events</code> function as an easy fix for sorting of events when tagging.</li>
<li>fixed odd interaction between <code><a href="https://dplyr.tidyverse.org/reference/select.html">select()</a></code> and <code><a href="../reference/validate_channels.html">validate_channels()</a></code> that reordered channel names in <code>chan_info</code>
</li>
<li>
<code>eeg_decomp</code> now doing better job of filtering for <code>ssd</code> method</li>
<li>various <code>tibble</code> related warnings and errors cleaned up.</li>
<li>
<code>method = "gam"</code> should now yield sensible results for <code><a href="../reference/geom_topo.html">geom_topo()</a></code>
</li>
<li>
<code><a href="../reference/run_ICA.html">run_ICA()</a></code> and <code>eeg_decomp()</code> methods now return components ordered by percent variance explained (high to low)</li>
<li>removed scaling of components in SOBI ICA method</li>
<li>
<code>browse_data().eeg_ica</code> grid res reduced</li>
<li>
<code>eeg_reference().eeg_epochs</code> was always average referencing, now fixed.</li>
<li>cleaner code in <code><a href="../reference/topoplot.html">topoplot()</a></code> for biharmonic smooth</li>
<li>
<code><a href="../reference/compute_psd.html">compute_psd()</a></code> now demeans individual segments when doing Welch FFT; also no longer errors when only one segment per channel</li>
<li>
<code><a href="../reference/eeg_tfr.html">eeg_tfr()</a></code> internal structure modified to keep 4 dimensions even after averaging, for consistency</li>
<li>
<code>stat_summary_by_fill()</code> added to do averaging for raster plots effectively.</li>
<li>
<code><a href="../reference/convert_tfr.html">convert_tfr()</a></code> now properly returns converted data</li>
<li>
<code><a href="../reference/import_raw.html">import_raw()</a></code> fix for Brain Vision Analyzer files with date fields in the markers</li>
<li>added <code>version</code> field to most objects</li>
</ul>
</div>
</div>
<div id="eegutils-050" class="section level1">
<h1 class="page-header" data-toc-text="0.5.0">
<a href="#eegutils-050" class="anchor"></a>eegUtils 0.5.0</h1>
<div id="function-changes-2" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-2" class="anchor"></a>Function changes</h3>
<ul>
<li><p>Default settings for Infomax ICA changed to be similar to EEGLAB/Fieldtrip.</p></li>
<li><p>Faster reading of bdf implemented. Old behaviour can be retained using <code>fast_bdf = FALSE</code> parameter to <code><a href="../reference/import_raw.html">import_raw()</a></code></p></li>
<li><p><code>eeg_combine</code> now supports combining lists.</p></li>
<li>
<p><code>eeg_reference</code> now supports <code>eeg_epochs</code> and <code>eeg_evoked</code> objects.</p>
<h3 id="internal-changes--bug-fixes-2">Internal changes / bug fixes</h3>
</li>
<li><p><code>plot_butterfly</code> should now be faster again.</p></li>
<li><p>Much faster reader for BDF implemented.</p></li>
<li><p><code>eeg_filter</code> added <code>demean</code> parameter so that removing channel/epoch means during filtering is now optional. Defaults to TRUE.</p></li>
<li>
<p>Added artefact detection options for ICA objects</p>
<ul>
<li>
<code><a href="../reference/ar_acf.html">ar_acf()</a></code> checks for low autocorrelation</li>
<li>
<code><a href="../reference/ar_chanfoc.html">ar_chanfoc()</a></code> checks for excessive channel focality (e.g. components that load mostly on one channel)</li>
<li>
<code><a href="../reference/ar_trialfoc.html">ar_trialfoc()</a></code> checks for trial focality (components that load mostly on a few trials)</li>
<li>
<code><a href="../reference/ar_eogcor.html">ar_eogcor()</a></code> checks for correlation with EOG channels</li>
</ul>
</li>
<li><p><code>topoplot</code> plotting radius logic altered</p></li>
<li><p><code>compute_csd</code> now uses <code>eeg_reference</code> rather than <code>reref_eeg</code></p></li>
<li><p>Unmixing matrix for SSD decompositions fixed.</p></li>
<li><p><code>compute_tfr</code> reworked to be faster.</p></li>
<li><p>Faster baseline correction implemented using Rcpp.</p></li>
<li><p>Padding now used during <code>compute_tfr</code>, which greatly improves speed/accuracy; units may change but this is a change in scaling factor.</p></li>
<li><p><code>epoch_data</code> now uses a more robust way of determining time limits/samples to include in each epoch that no longer fails at some combinations of time limit and sampling rate</p></li>
<li><p><code>eeg_average</code> returns objects of class(<code>eeg_evoked</code>, <code>eeg_epochs</code>)</p></li>
<li><p>Updated R requirement to >= 3.2.0</p></li>
<li><p>Updated rlang requirement to >= 0.4.0</p></li>
<li><p><code>compute_psd</code> fix for single segment data</p></li>
<li><p>updated use of <code>nest</code> and <code>unnest</code> in keeping with <code>tidyr 1.0.0</code></p></li>
<li><p><code><a href="../reference/as.data.frame.eeg_tfr.html">as.data.frame.eeg_tfr()</a></code> now fixed to output correctly</p></li>
</ul>
</div>
</div>
<div id="eegutils-040" class="section level1">
<h1 class="page-header" data-toc-text="0.4.0">
<a href="#eegutils-040" class="anchor"></a>eegUtils 0.4.0</h1>
<div id="function-changes-3" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-3" class="anchor"></a>Function changes</h3>
<ul>
<li>Behaviour of <code>as.data.frame</code> methods changed.
<ul>
<li>
<code>cond_label</code> parameter is deprecated</li>
<li>Information from the new <code>epochs</code> structure is now automatically added to the data.frame</li>
</ul>
</li>
<li>
<code>tag_epochs</code> function added for labelling</li>
<li>
<code>run_ICA</code> now includes the <code>fICA</code> package version of <code>fastica</code>, and now supports running PCA before ICA.</li>
<li>
<code>apply_ICA</code> function added to remove ICA components.</li>
<li>Behaviour of <code><a href="../reference/select_times.html">select_times()</a></code> changed to use exact supplied times rather than finding nearest times in the data.</li>
<li>Some wrappers around <code>dplyr</code> functions added:
<ul>
<li>
<code><a href="https://dplyr.tidyverse.org/reference/select.html">select()</a></code> now works for selecting electrodes from <code>eeg_data</code> and <code>eeg_epochs</code> objects.</li>
<li>
<code><a href="https://dplyr.tidyverse.org/reference/filter.html">filter()</a></code> filters by time points or epochs from <code>eeg_data</code> and <code>eeg_epochs</code> objects.</li>
<li>
<code><a href="https://dplyr.tidyverse.org/reference/mutate.html">mutate()</a></code> adds columns to the <code>signals</code> from <code>eeg_data</code> and <code>eeg_epochs</code> objects.</li>
</ul>
</li>
<li>
<code><a href="../reference/topoplot.html">topoplot()</a></code> now has a <code>groups</code> parameter that allows the possibility of facetting by event labels.</li>
<li>more Biosemi montages added</li>
<li>
<code><a href="../reference/events.html">events()</a></code> function added to easily access and modify the events structure of all <code>eegUtils</code> objects.</li>
<li>
<code><a href="../reference/channels.html">channels()</a></code> function added to easily access and modify the chan_info structure of all <code>eegUtils</code> objects.</li>
<li>
<code><a href="../reference/epochs.html">epochs()</a></code> function added to access and modify epochs structure.</li>
<li>
<code><a href="../reference/ar_eogreg.html">ar_eogreg()</a></code> function added for removing eye movement activity using regression.</li>
<li>
<code><a href="../reference/eeg_filter.html">eeg_filter()</a></code> function added for a unified method of filtering using either FIR or IIR
<ul>
<li>
<code><a href="../reference/eeg_filter.html">eeg_filter()</a></code> supports use of multiple threads/cores through the <code>future</code> package.</li>
<li>
<code><a href="../reference/iir_filt.html">iir_filt()</a></code> will be deprecated</li>
</ul>
</li>
<li>
<code><a href="../reference/geom_topo.html">geom_topo()</a></code> extension for <code>ggplot2</code> added. Allows plotting of a topographical scalp maps using standard <code>ggplot2</code> functions.</li>
<li>Default <code>grid_res</code> for topography related plots increased to 200.</li>
</ul>
</div>
<div id="internal-changes--bug-fixes-3" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes--bug-fixes-3" class="anchor"></a>Internal changes / bug fixes</h3>
<ul>
<li>
<code>data.table</code> now used in the following functions internally:
<ul>
<li><code><a href="../reference/eeg_reference.html">reref_eeg()</a></code></li>
<li><code><a href="../reference/iir_filt.html">iir_filt()</a></code></li>
<li><code><a href="../reference/ar_FASTER.html">eeg_FASTER()</a></code></li>
</ul>
</li>
<li>
<code><a href="../reference/eeg_reference.html">reref_eeg()</a></code> now correctly excludes electrodes as requested.</li>
<li>
<code><a href="../reference/iir_filt.html">iir_filt()</a></code> now correctly respects epoch boundaries.</li>
<li>New field <code>epochs</code> added to <code>eeg_data</code> and <code>eeg_epochs</code> objects.</li>
<li>
<code>chan_info</code> changes to make chan_info consistent across systems.</li>
<li>Corrected scaling factor for PSD</li>
<li>
<code>eeg_combine</code> now checks and fixes <code>eeg_data</code> timing consistency</li>
<li>
<code>eeg_tfr</code> objects now use differently organised underlying matrices.</li>
<li>
<code>eeg_ICA</code> fixed unmixing matrices, which were transposed.</li>
</ul>
</div>
</div>
<div id="eegutils-030" class="section level1">
<h1 class="page-header" data-toc-text="0.3.0">
<a href="#eegutils-030" class="anchor"></a>eegUtils 0.3.0</h1>
<div id="function-changes-4" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-4" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code><a href="../reference/topoplot.html">topoplot()</a></code> now has a scaling parameter to scale the size of any lines or markers drawn on the plot.</li>
<li>
<code><a href="../reference/plot_tfr.html">plot_tfr()</a></code> function now useable, with baseline correction also added.</li>
<li>
<code><a href="../reference/rm_baseline.html">rm_baseline()</a></code> now handles <code>eeg_tfr</code> objects.</li>
<li>
<code><a href="https://rdrr.io/r/base/as.data.frame.html">as.data.frame()</a></code> method added for <code>eeg_tfr</code> objects.</li>
<li>
<code><a href="../reference/compute_tfr.html">compute_tfr()</a></code> function now available for use with Morlet wavelets.</li>
<li>
<code><a href="../reference/plot_psd.html">plot_psd()</a></code> now allows changing of FFT parameters (e.g. number of FFT points, segment length)</li>
<li>Data selectors added for <code>eeg_tfr</code> objects (e.g. <code><a href="../reference/select_elecs.html">select_elecs()</a></code>)</li>
</ul>
</div>
<div id="internal-changes-bug-fixes" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes-bug-fixes" class="anchor"></a>Internal changes/ bug fixes</h3>
<ul>
<li>
<code><a href="../reference/plot_timecourse.html">plot_timecourse()</a></code> overhauled to be S3 method.</li>
<li>
<code><a href="../reference/plot_butterfly.html">plot_butterfly()</a></code> reworked internally to be more efficient</li>
<li>
<code><a href="../reference/rm_baseline.html">rm_baseline()</a></code> simplified internally, reworked to use matrices; split to separate file.</li>
<li>
<code><a href="../reference/select_elecs.html">select_elecs()</a></code> now works for <code>eeg_evoked</code> objects</li>
<li>
<code>eeg_decomp</code> function in progress for performing SSD analyses</li>
<li>Various methods added for TFR analyses</li>
<li>
<code><a href="../reference/topoplot.html">topoplot()</a></code> improvements internally. Now offers potential for facetting.</li>
<li>Some <code>dplyr</code> functions implemented internally for some objects.</li>
</ul>
</div>
</div>
<div id="eegutils-021" class="section level1">
<h1 class="page-header" data-toc-text="0.2.1">
<a href="#eegutils-021" class="anchor"></a>eegUtils 0.2.1</h1>
<div id="function-changes-5" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-5" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code><a href="../reference/topoplot.html">topoplot()</a></code> added highlights parameter to allow specific electrodes to be highlighted.</li>
<li>
<code><a href="../reference/run_ICA.html">run_ICA()</a></code> now offers extended Infomax and Fastica thanks to the <code>ica</code> package</li>
<li>
<code>plotly</code> is now a “suggested” package rather than a dependency</li>
<li>
<code><a href="../reference/plot_psd.html">plot_psd()</a></code> function added to calculate and plot the PSD for <code>eeg_epochs</code> and <code>eeg_data</code> objects</li>
<li>
<code><a href="../reference/plot_tfr.html">plot_tfr()</a></code> function added to handle <code>eeg_tfr</code> objects.</li>
<li>
<code><a href="../reference/erp_image.html">erp_image()</a></code> now works with <code>eeg_ICA</code> objects</li>
<li>Generic print methods added for <code>eeg_epochs</code> and <code>eeg_data</code>
</li>
<li>
<code><a href="../reference/compute_tfr.html">compute_tfr()</a></code> function added to performed TFA on <code>eeg_epochs</code>
</li>
<li>
<code><a href="../reference/epoch_data.html">epoch_data()</a></code> now warns if some events are not found rather than stops. Only stops if <em>no</em> events are found.</li>
</ul>
</div>
<div id="internal-changes-bug-fixes-1" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes-bug-fixes-1" class="anchor"></a>Internal changes/ bug fixes</h3>
<ul>
<li>
<code><a href="../reference/eeg_reference.html">reref_eeg()</a></code>
<ul>
<li>correctly excludes multiple named electrodes (i.e. passed as characters rather than numbers), where it previously silently failed.</li>
<li>no longer records the reference data in the <code>ref_data</code> field</li>
</ul>
</li>
<li>
<code>tf_morlet</code> recoded to be called internally</li>
<li>
<code><a href="../reference/compute_psd.html">compute_psd()</a></code>
<ul>
<li>recoded to call <code><a href="../reference/welch_fft.html">welch_fft()</a></code> in order to support possibility of different FFT methods.</li>
<li>now drops the DC component (frequency 0)</li>
</ul>
</li>
<li>
<code><a href="../reference/welch_fft.html">welch_fft()</a></code> internal function added</li>
<li>
<code><a href="../reference/eeg_downsample.html">eeg_downsample()</a></code> now makes sure epoch length is a multiple of the downsampling factor to avoid problems with timing jitter</li>
<li>
<code><a href="../reference/erp_image.html">erp_image()</a></code> is now an S3 method</li>
<li>
<code><a href="../reference/run_ICA.html">run_ICA()</a></code>
<ul>
<li>now returns source activations as a “signals” data frame, with component names</li>
<li>now returns correct unmixing matrix</li>
</ul>
</li>
<li>
<code><a href="../reference/compute_csd.html">compute_csd()</a></code>
<ul>
<li>added.</li>
<li>computation of g-matrix and h-matrix refactored, spherical spline calculation altered accordingly</li>
</ul>
</li>
<li>
<code><a href="../reference/compute_tfr.html">compute_tfr()</a></code>
<ul>
<li>added</li>
</ul>
</li>
<li>
<code><a href="../reference/ar_FASTER.html">eeg_FASTER()</a></code> now properly selects electrodes and epochs for removal</li>
</ul>
</div>
</div>
<div id="eegutils-020" class="section level1">
<h1 class="page-header" data-toc-text="0.2.0">
<a href="#eegutils-020" class="anchor"></a>eegUtils 0.2.0</h1>
<div id="function-changes-6" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-6" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code><a href="../reference/as.data.frame.eeg_epochs.html">as.data.frame.eeg_epochs()</a></code> now has a <code>cond_labels</code> parameter to select epochs with specific events and add the event label as an additional column.</li>
<li>
<code><a href="https://rdrr.io/r/base/as.data.frame.html">as.data.frame()</a></code> methods now drop the <code>sample</code> column.</li>
<li>
<code><a href="../reference/as.data.frame.eeg_ICA.html">as.data.frame.eeg_ICA()</a></code> now has a <code>cond_labels</code> parameter to select epochs with specific events and add the event label as an additional column.</li>
<li>
<code><a href="../reference/eeg_reference.html">reref_eeg()</a></code> now removes reference channels from the data.</li>
<li>
<code><a href="../reference/ar_FASTER.html">eeg_FASTER()</a></code> - FASTER artefact rejection method now (mostly) implemented (<em>experimental</em>).</li>
</ul>
</div>
<div id="internal-changes--bug-fixes-4" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes--bug-fixes-4" class="anchor"></a>Internal changes / bug fixes</h3>
<ul>
<li>
<code><a href="../reference/plot_butterfly.html">plot_butterfly()</a></code> some <code>dplyr</code> use removed.</li>
<li>
<code>run_ica()</code> refactored SOBI method, JADE dependency removed.</li>
<li>
<code><a href="../reference/montage_check.html">montage_check()</a></code> command parses montage info when passed to <code><a href="../reference/electrode_locations.html">electrode_locations()</a></code>
</li>
<li>
<code><a href="../reference/label_check.html">label_check()</a></code> added to help parse event labels</li>
<li>
<code><a href="../reference/proc_events.html">proc_events()</a></code> added to help parse event labels during <code><a href="../reference/select_epochs.html">select_epochs()</a></code> calls</li>
<li>
<code><a href="../reference/topoplot.html">topoplot()</a></code> now tries to average/select across time/epochs before converting to long data, less memory use</li>
<li>
<code><a href="../reference/select_elecs.html">select_elecs()</a></code> also removes electrodes from chan_info</li>
<li>
<code><a href="../reference/select_epochs.html">select_epochs()</a></code> fixed bug where <code>events</code> and <code>timings</code> were inconsistent when using <code>keep = FALSE</code>
</li>
<li>Electrode/channel related functions (other than selection) now moved to <code>channel_management.r</code>
</li>
<li>New default electrode locations (347 locations in the 10-05 layout) provided</li>
</ul>
</div>
</div>
<div id="eegutils-0115" class="section level1">
<h1 class="page-header" data-toc-text="0.1.15">
<a href="#eegutils-0115" class="anchor"></a>eegUtils 0.1.15</h1>
<div id="function-changes-7" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-7" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code><a href="../reference/eeg_evoked.html">eeg_evoked()</a></code> class introduced to hold ERPS</li>
<li>
<code><a href="../reference/eeg_ICA.html">eeg_ICA()</a></code> class introduced to hold ICA decompositions</li>
<li>
<code><a href="../reference/eeg_average.html">eeg_average()</a></code> function to calculate averages (e.g. ERPs) from <code>eeg_epochs</code> objects</li>
<li>
<code><a href="../reference/as.data.frame.eeg_evoked.html">as.data.frame.eeg_evoked()</a></code> introduced to handle conversion of eeg_evoked objects to data frames.</li>
</ul>
</div>
<div id="internal-changes--bug-fixes-5" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes--bug-fixes-5" class="anchor"></a>Internal changes / bug fixes</h3>
<ul>
<li>
<code><a href="../reference/compute_psd.html">compute_psd()</a></code> function development, converted to S3method.</li>
<li>
<code><a href="../reference/topoplot.html">topoplot()</a></code> properly checks for existing chan_info in <code>eeg_data</code> objects</li>
<li>
<code><a href="../reference/plot_timecourse.html">plot_timecourse()</a></code> and <code><a href="../reference/plot_butterfly.html">plot_butterfly()</a></code> modified to deal with <code>eeg_evoked</code> objects.</li>
<li>
<code><a href="../reference/plot_butterfly.html">plot_butterfly()</a></code> updated to better handle data frames</li>
<li>
<code><a href="../reference/topoplot.html">topoplot.eeg_ICA()</a></code> added to make topolots from ICA components</li>
<li>
<code><a href="../reference/rm_baseline.html">rm_baseline()</a></code> reworked as S3 method and to be faster and much less memory intensive.</li>
<li>
<code><a href="../reference/plot_butterfly.html">plot_butterfly()</a></code> converted to S3 method.</li>
<li>Initial commits for addition of Morlet wavelet time-frequency analysis</li>
<li>Initial commits for statisical comparisons added</li>
</ul>
</div>
</div>
<div id="eegutils-0114" class="section level1">
<h1 class="page-header" data-toc-text="0.1.14">
<a href="#eegutils-0114" class="anchor"></a>eegUtils 0.1.14</h1>
<div id="function-changes-8" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-8" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code><a href="../reference/eeg_downsample.html">eeg_downsample()</a></code> function added to downsample EEG data by an integer factor.</li>
<li>
<code><a href="../reference/tag_events.html">tag_events()</a></code> function added to give labels to event codes.</li>
<li>
<code><a href="../reference/list_events.html">list_events()</a></code> added to display unique event codes and their associated labels.</li>
<li>
<code><a href="../reference/select_epochs.html">select_epochs()</a></code> now allows selection of epochs by event code or event label.</li>
<li>
<code><a href="../reference/erp_raster.html">erp_raster()</a></code> - plot ERPs across the scalp as an ERP image</li>
<li>
<code><a href="../reference/eeg_combine.html">eeg_combine()</a></code> - combine multiple <code>eeg_data</code> or <code>eeg_epochs</code> objects into one</li>
</ul>
</div>
<div id="internal-changes-bug-fixes-2" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes-bug-fixes-2" class="anchor"></a>Internal changes/ bug fixes</h3>
<ul>
<li>
<code><a href="../reference/eeg_epochs.html">eeg_epochs()</a></code> now also handles downsampled data appropriately.</li>
<li>
<code><a href="../reference/select_times.html">select_times()</a></code> no longer leaves “epoch” column in <code>eeg_epochs</code> objects.</li>
<li>
<code><a href="../reference/topoplot.html">topoplot()</a></code> now calls a separate function (<code>gam_topo()</code>) to create GAM smooths</li>
<li>
<code><a href="../reference/browse_data.html">browse_data()</a></code> major speed-ups, no longer converts to long format until necessary. Converted to S3method.</li>
<li>
<code><a href="../reference/interactive_scalp.html">interactive_scalp()</a></code> fixed plotting of individual electrodes</li>
</ul>
</div>
</div>
<div id="eegutils-0113" class="section level1">
<h1 class="page-header" data-toc-text="0.1.13">
<a href="#eegutils-0113" class="anchor"></a>eegUtils 0.1.13</h1>
<div id="function-changes-9" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-9" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code><a href="../reference/interp_elecs.html">interp_elecs()</a></code> function to perform spherical spline interpolation of individual electrodes</li>
<li>
<code>eeg_ar_thresh()</code> simple absolute value thresholding added</li>
<li>
<code><a href="../reference/plot_electrodes.html">plot_electrodes()</a></code> Produces a 2D or interactive 3D plot of electrode locations</li>
</ul>
</div>
</div>
<div id="eegutils-0112" class="section level1">
<h1 class="page-header" data-toc-text="0.1.12">
<a href="#eegutils-0112" class="anchor"></a>eegUtils 0.1.12</h1>
<div id="function-changes-10" class="section level3">
<h3 class="hasAnchor">
<a href="#function-changes-10" class="anchor"></a>Function changes</h3>
<ul>
<li>
<code><a href="../reference/iir_filt.html">iir_filt()</a></code> now also filters reference channels</li>
<li>
<code>load_set()</code> command added to load EEGLAB .set files</li>
</ul>
</div>
<div id="internal-changes" class="section level3">
<h3 class="hasAnchor">
<a href="#internal-changes" class="anchor"></a>Internal changes</h3>
<ul>
<li>Converted <code><a href="../reference/select_times.html">select_times()</a></code> to an S3 generic method
<ul>
<li><code>select_times.eeg_data</code></li>
<li><code>select_times.eeg_epochs</code></li>
</ul>
</li>
<li>Converted <code><a href="../reference/iir_filt.html">iir_filt()</a></code> to an S3 generic method
<ul>
<li><code>iir_filt.eeg_data</code></li>
<li><code>iir_filt.eeg_epochs</code></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="eegutils-0111" class="section level1">
<h1 class="page-header" data-toc-text="0.1.11">
<a href="#eegutils-0111" class="anchor"></a>eegUtils 0.1.11</h1>
<ul>
<li>Added a <code>NEWS.md</code> file to track changes to the package.</li>
</ul>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top">
<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>