electrode_locations: Get standard electrode locations

In craddm/eegUtils: Utilities for Electroencephalographic (EEG) Analysis

Get standard electrode locations

Description

Joins standard electrode locations to EEG data from eegUtils internal data.

Usage

electrode_locations(data, ...)

## S3 method for class 'data.frame'
electrode_locations(
  data,
  electrode = "electrode",
  drop = FALSE,
  montage = NULL,
  ...
)

## S3 method for class 'eeg_data'
electrode_locations(data, drop = FALSE, montage = NULL, overwrite = FALSE, ...)

## S3 method for class 'eeg_epochs'
electrode_locations(data, drop = FALSE, montage = NULL, overwrite = FALSE, ...)

## S3 method for class 'eeg_tfr'
electrode_locations(data, drop = FALSE, montage = NULL, overwrite = FALSE, ...)

Arguments

data	An EEG dataset.
...	Passed to S3 methods.
electrode	The column name containing electrode names in data. (Defaults to "electrode").
drop	Should electrodes in data for which default locations are not available be removed? (Defaults to FALSE).
montage	Name of an existing montage set. Defaults to NULL.
overwrite	Overwrite existing channel info. Defaults to FALSE.

Details

The standard locations are from the 10-05 system derived by Oostenveld & Praamstra (2001). In addition, there are multiple specific montages for BioSemi systems included. These can be added using the montage parameter: "biosemi16", "biosemi32", biosemi64", "biosemi64alpha", "biosemi128", "biosemi160", "biosemi256"

Value

A tibble (or data.frame), or ggplot2 object if plot = TRUE.

Methods (by class)

• data.frame: Adds standard locations to a data frame in long format

• eeg_data: Adds standard locations to the chan_info field of an eeg_data object.

• eeg_epochs: Adds standard locations to the chan_info field of an eeg_data object.

• eeg_tfr: Adds standard locations to the chan_info field of an eeg_tfr object.

References

Oostenveld, R. & Praamstra, P. (2001). The five percent electrode system for high-resolution EEG and ERP measurements. Clinical Neurophysiology, 112, 4, 713-719

Examples

channels(demo_epochs)
electrode_locations(demo_epochs, overwrite = TRUE, montage = "biosemi64alpha")

craddm/eegUtils documentation built on March 24, 2022, 9:17 a.m.