select_epochs: Select epochs

View source: R/data_selection.R

select_epochsR Documentation

Select epochs

Description

This is a generic function for selecting epochs from an epoched data set.

Usage

select_epochs(data, ...)

## Default S3 method:
select_epochs(data, ...)

## S3 method for class 'eeg_epochs'
select_epochs(
  data,
  epoch_events = NULL,
  epoch_no = NULL,
  keep = TRUE,
  df_out = FALSE,
  ...
)

## S3 method for class 'eeg_ICA'
select_epochs(
  data,
  epoch_events = NULL,
  epoch_no = NULL,
  keep = TRUE,
  df_out = FALSE,
  ...
)

## S3 method for class 'eeg_tfr'
select_epochs(
  data,
  epoch_events = NULL,
  epoch_no = NULL,
  keep = TRUE,
  df_out = FALSE,
  ...
)

Arguments

data

eeg_epochs object from which to select epochs.

...

Parameters passed to specific methods

epoch_events

Select epochs containing any of the specified events. Can be numeric or a character string. Will override any epoch_no input.

epoch_no

Select epochs by epoch number.

keep

Defaults to TRUE, meaning select the specified epochs. Set to FALSE to remove specified epochs.

df_out

Output a data.frame instead of an eeg_data object.

Methods (by class)

  • default: Select from generic object

  • eeg_epochs: Selection of epochs from eeg_epochs objects.

  • eeg_ICA: Selection of epochs from eeg_ICA objects.

  • eeg_tfr: Selection of epochs from eeg_tfr objects.

Author(s)

Matt Craddock, matt@mattcraddock.com

See Also

select_times() and select_elecs()

Examples

select_epochs(demo_epochs, epoch_no = 1:5)
demo_ica <- run_ICA(demo_epochs, pca = 10)
select_epochs(demo_ica, epoch_no = 1:5)


neuroconductor/eegUtils documentation built on Feb. 3, 2023, 5:33 p.m.