Package: eegUtils 0.7.0

eegUtils: Utilities for Electroencephalographic (EEG) Analysis

EEG processing and visualization tools. Includes import functions for 'BioSemi' (.BDF), 'Neuroscan' (.CNT), 'Brain Vision Analyzer' (.VHDR), 'EEGLAB' (.set) and 'Fieldtrip' (.mat). Many preprocessing functions such as referencing, epoching, filtering, and ICA are available. There are a variety of visualizations possible, including timecourse and topographical plotting.

Authors:Matt Craddock [aut, cre, cph], Matti Vuorre [ctb], ggplot2 authors [ctb, cph]

eegUtils_0.7.0.tar.gz
eegUtils_0.7.0.zip(r-4.5)eegUtils_0.7.0.zip(r-4.4)eegUtils_0.7.0.zip(r-4.3)
eegUtils_0.7.0.tgz(r-4.4-x86_64)eegUtils_0.7.0.tgz(r-4.4-arm64)eegUtils_0.7.0.tgz(r-4.3-x86_64)eegUtils_0.7.0.tgz(r-4.3-arm64)
eegUtils_0.7.0.tar.gz(r-4.5-noble)eegUtils_0.7.0.tar.gz(r-4.4-noble)
eegUtils_0.7.0.tgz(r-4.4-emscripten)eegUtils_0.7.0.tgz(r-4.3-emscripten)
eegUtils.pdf |eegUtils.html
eegUtils/json (API)
NEWS

# Install 'eegUtils' in R:
install.packages('eegUtils', repos = c('https://craddm.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/craddm/eegutils/issues

Uses libs:
  • openblas– Optimized BLAS
  • c++– GNU Standard C++ Library v3
  • openmp– GCC OpenMP (GOMP) support library
Datasets:

On CRAN:

eegeeg-analysiseeg-dataeeg-signalseeg-signals-processing

93 exports 100 stars 4.05 score 88 dependencies 73 scripts

Last updated 3 years agofrom:aeb0ec00c2. Checks:OK: 1 NOTE: 8. Indexed: yes.

TargetResultDate
Doc / VignettesOKAug 25 2024
R-4.5-win-x86_64NOTEAug 25 2024
R-4.5-linux-x86_64NOTEAug 25 2024
R-4.4-win-x86_64NOTEAug 25 2024
R-4.4-mac-x86_64NOTEAug 25 2024
R-4.4-mac-aarch64NOTEAug 25 2024
R-4.3-win-x86_64NOTEAug 25 2024
R-4.3-mac-x86_64NOTEAug 25 2024
R-4.3-mac-aarch64NOTEAug 25 2024

Exports:apply_icaar_acfar_chanfocar_eogcorar_eogregar_FASTERar_threshar_trialfocbrowse_datachannel_nameschannel_statschannelschannels<-compute_csdcompute_itccompute_psdcompute_tfrcycle_calceeg_averageeeg_combineeeg_decomposeeeg_downsampleeeg_epochseeg_FASTEReeg_filtereeg_ICAeeg_referenceelectrode_locationsepoch_dataepoch_statsepochsepochs<-erp_imageerp_rastererp_scalpeventsevents<-export_bvafilterfit_glmfortifygeom_channelsgeom_earsgeom_headgeom_maskgeom_topoget_participant_idget_recordingget_scalpmapiir_filtimport_chansimport_erplabimport_ftimport_rawimport_setinteractive_scalpinterp_elecsis.eeg_epochsis.eeg_evokedis.eeg_groupis.eeg_ICAis.eeg_statsis.eeg_tfrlist_epochslist_eventsmutateplot_butterflyplot_differenceplot_electrodesplot_psdplot_tfrplot_timecourserenamereref_eegrm_baselinerotate_anglerun_ICAselectselect_elecsselect_epochsselect_freqsselect_timesset_participant_idset_recordingstat_scalpcontoursstat_scalpmapStatScalpContoursStatScalpmaptag_epochstag_eventstopoplotview_artefactsview_ica

Dependencies:abindaskpassbase64encbslibcachemclicodetoolscolorspacecommonmarkcpp11crayoncrosstalkcurldata.tabledigestdplyrevaluatefansifarverfastmapfontawesomefsfuturefuture.applygenericsggplot2globalsgluegtablehighrhtmltoolshtmlwidgetshttpuvhttrisobandjquerylibjsonliteknitrlabelinglaterlatticelazyevallifecyclelistenvmagrittrMASSMatrixmatrixStatsmemoisemgcvmimeminiUImunsellnlmeopensslparallellypillarpkgconfigplotlypracmapromisespurrrR6rappdirsRColorBrewerRcppRcppArmadillorlangrmarkdownsassscalesshinysignalsourcetoolsstringistringrsystibbletidyrtidyselecttinytexutf8vctrsviridisLitewithrxfunxtableyaml

A guide to eegUtils data structures

Rendered fromdata_structures.Rmdusingknitr::rmarkdownon Aug 25 2024.

Last update: 2021-07-06
Started: 2018-04-07

EEG Utils

Rendered fromeegUtils.Rmdusingknitr::rmarkdownon Aug 25 2024.

Last update: 2022-02-07
Started: 2018-05-16

Event and epoch handling

Rendered fromepoch-handling.Rmdusingknitr::rmarkdownon Aug 25 2024.

Last update: 2019-11-04
Started: 2019-03-03

Frequency analysis

Rendered fromtime-frequency-analysis.Rmdusingknitr::rmarkdownon Aug 25 2024.

Last update: 2022-02-07
Started: 2018-10-28

Readme and manuals

Help Manual

Help pageTopics
Recreate channel timecourses from ICA decompositions.apply_ica apply_ica.eeg_epochs apply_ica.eeg_ICA
Detect low autocorrelation of ICA componentsar_acf ar_acf.eeg_ICA
Detect high channel focality of ICA componentsar_chanfoc
Detect high component correlation with eye channelsar_eogcor ar_eogcor.eeg_ICA
Remove EOG using regressionar_eogreg ar_eogreg.eeg_data ar_eogreg.eeg_epochs
FASTER EEG artefact rejectionar_FASTER ar_FASTER.eeg_epochs ar_FASTER.eeg_group eeg_FASTER
Simple absolute value thresholdingar_thresh ar_thresh.eeg_data ar_thresh.eeg_epochs
Detect high trial focality of ICA componentsar_trialfoc
Convert 'eeg_data' to 'data.frame'as.data.frame.eeg_data
Convert 'eeg_epochs' object to data.frameas.data.frame.eeg_epochs
Convert 'eeg_evoked' object to data frameas.data.frame.eeg_evoked
Convert 'eeg_ICA' object to data frameas.data.frame.eeg_ICA
Convert 'eeg_lm' to data.frameas.data.frame.eeg_lm
Convert 'eeg_stats' objects to data framesas.data.frame.eeg_stats
Convert 'eeg_tfr' objects to data framesas.data.frame.eeg_tfr
Browse EEG data.browse_data browse_data.eeg_data browse_data.eeg_epochs browse_data.eeg_ICA
Retrieve signal/channel nameschannel_names
Channel statisticschannel_stats channel_stats.eeg_data
Modify channel informationchannels channels<-
Convert to Current Source Densitycompute_csd compute_csd.default compute_csd.eeg_data compute_csd.eeg_epochs
Calculate inter-trial coherencecompute_itc
Compute power spectral densitycompute_psd compute_psd.eeg_data compute_psd.eeg_epochs compute_psd.eeg_evoked
Compute Time-Frequency representation of EEG datacompute_tfr compute_tfr.default compute_tfr.eeg_epochs compute_tfr.eeg_evoked
Calculate cyclescycle_calc
A demo 'eeg_epochs' datasetdemo_epochs
A demo 'eeg_epochs' datasetdemo_spatial
Calculate averages (e.g. ERPs) for single datasetseeg_average eeg_average.default eeg_average.eeg_epochs eeg_average.eeg_evoked eeg_average.eeg_tfr
Combine 'eegUtils' objectseeg_combine eeg_combine.eeg_data eeg_combine.eeg_epochs eeg_combine.eeg_evoked eeg_combine.list
Generalized eigenvalue decomposition based methods for EEG dataeeg_decompose eeg_decompose.eeg_epochs
Downsampling EEG dataeeg_downsample eeg_downsample.eeg_data eeg_downsample.eeg_epochs
Function to create an S3 object of class 'eeg_epochs'.eeg_epochs
Filter EEG dataeeg_filter eeg_filter.eeg_data eeg_filter.eeg_epochs eeg_filter.eeg_group
Function to create an S3 object of class 'eeg_ICA'.eeg_ICA
Referencingeeg_reference eeg_reference.default eeg_reference.eeg_data eeg_reference.eeg_epochs reref_eeg
Get standard electrode locationselectrode_locations electrode_locations.data.frame electrode_locations.eeg_data electrode_locations.eeg_epochs electrode_locations.eeg_tfr
Create epochs from EEG dataepoch_data epoch_data.eeg_data
Create epochs from EEG dataepoch_data.default
Epoch statisticsepoch_stats epoch_stats.eeg_epochs
Modify the epochs structureepochs epochs<-
Plot ERP imageserp_image erp_image.data.frame erp_image.eeg_epochs erp_image.eeg_ICA erp_image.eeg_tfr
ERP raster ploterp_raster
Plot event-related potentials using a scalp based layouterp_scalp erp_scalp.default
Modify events structureevents events<- events<-.eeg_data events<-.eeg_epochs
Export continuous data in Brain Vision Analyzer formatexport_bva export_bva.eeg_data
Fit a linear model to EEG datafit_glm fit_glm.eeg_epochs
Create a topographical plotgeom_topo
Query and set elements of the 'epochs' metadata structuresget_participant_id get_recording set_participant_id set_recording
Calculate an interpolated scalpmapget_scalpmap get_scalpmap.data.frame get_scalpmap.eeg_epochs
Butterworth IIR filteriir_filt iir_filt.data.frame iir_filt.eeg_data iir_filt.eeg_epochs
Import channel locations from various file formatsimport_chans
Import from ERPLAB .erp filesimport_erplab
Import Fieldtrip filesimport_ft
Function for reading raw data.import_raw
Load 'EEGLAB' .set filesimport_set
Interactive scalp mapsinteractive_scalp
Channel interpolationinterp_elecs interp_elecs.eeg_data
Check if object is of class 'eeg_epochs'.is.eeg_epochs
Check if object is of class 'eeg_evoked'is.eeg_evoked
Check if object is of class 'eeg_group'is.eeg_group
Check if object is of class 'eeg_ICA'is.eeg_ICA
Check if object is of class 'eeg_stats'is.eeg_stats
Check if object is of class 'eeg_tfr'is.eeg_tfr
List epochslist_epochs list_epochs.eeg_epochs list_epochs.eeg_ICA
List eventslist_events
Create a butterfly plot from timecourse dataplot_butterfly plot_butterfly.default plot_butterfly.eeg_data plot_butterfly.eeg_epochs plot_butterfly.eeg_evoked plot_butterfly.eeg_lm plot_butterfly.eeg_stats
Plot ERP difference wavesplot_difference plot_difference.eeg_epochs
Plot electrode locationsplot_electrodes plot_electrodes.default plot_electrodes.eeg_data plot_electrodes.eeg_tfr
Plot Power Spectral Densityplot_psd plot_psd.data.frame plot_psd.eeg_data plot_psd.eeg_epochs plot_psd.eeg_evoked plot_psd.eeg_group plot_psd.eeg_ICA
Time-frequency plotplot_tfr
Plot 1-D timecourse data.plot_timecourse plot_timecourse.data.frame plot_timecourse.eeg_epochs plot_timecourse.eeg_evoked plot_timecourse.eeg_group plot_timecourse.eeg_ICA plot_timecourse.eeg_tfr
Print 'eeg_data' summaryprint.eeg_data
Print 'eeg_epochs' summaryprint.eeg_epochs
Print 'eeg_evoked' summaryprint.eeg_evoked
Print 'eeg_group' summaryprint.eeg_group
Print 'eeg_epochs' summaryprint.eeg_ICA
Print 'eeg_lm' summaryprint.eeg_lm
Print 'eeg_stats' summaryprint.eeg_stats
Print 'eeg_tfr' summaryprint.eeg_tfr
Baseline correctionrm_baseline rm_baseline.data.frame rm_baseline.eeg_data rm_baseline.eeg_epochs rm_baseline.eeg_evoked rm_baseline.eeg_tfr
Rotate channel locationsrotate_angle
Independent Component Analysis for EEG datarun_ICA run_ICA.eeg_epochs
Select electrodes from a given datasetselect_elecs select_elecs.default select_elecs.eeg_data select_elecs.eeg_evoked select_elecs.eeg_ICA select_elecs.eeg_tfr
Select epochsselect_epochs select_epochs.default select_epochs.eeg_epochs select_epochs.eeg_ICA select_epochs.eeg_tfr
Select frequenciesselect_freqs select_freqs.eeg_tfr
Select timerangeselect_times select_times.default select_times.eeg_data select_times.eeg_epochs select_times.eeg_evoked select_times.eeg_tfr
Create an interpolated scalp surfacestat_scalpcontours
Create an interpolated scalp surfacegeom_channels geom_ears geom_head geom_mask stat_scalpmap
Tag epochs with labelstag_epochs tag_epochs.default tag_epochs.eeg_epochs
Tag eventstag_events tag_events.eeg_data tag_events.eeg_epochs
Topographical Plotting Function for EEGtopoplot topoplot.data.frame topoplot.default topoplot.eeg_data topoplot.eeg_epochs topoplot.eeg_ICA topoplot.eeg_tfr
Artefact browserview_artefacts
EEG component viewerview_ica