artrejOptions: Options for artifact rejection

Description Usage Arguments Details Value Note

View source: R/erp_preprocess.R

Description

artrejOptions allows to set the parameters of the artifact rejection methods.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
artrejOptions(
  sampling_freq = 1000,
  channels = "all",
  apply_maxgrad = TRUE,
  maxgrad_limit = 50,
  maxgrad_mark = c(-200, 200),
  apply_diffrange = TRUE,
  diffrange_limit = c(0.5, 100),
  diffrange_mark = c(-200, 200),
  diffrange_interval = 200,
  apply_amplrange = TRUE,
  amplrange_limit = c(-200, 200),
  amplrange_mark = c(-200, 200)
)

Arguments

sampling_freq

numeric value, the sampling frequency of the EEG-data

channels

character vector containing the name or index of channels which are subject to artifact rejection. If set to "all" (default), all channels are included.

apply_maxgrad

logical value, if set to TRUE (default), the maximum gradient criterion is applied.

maxgrad_limit

numeric value, the maximum gradient / millisecond (default: 50)

maxgrad_mark

numeric vector of length 2; the placement of the Bad Interval mark in milliseconds before and after the occurence of maxgrad_limit violation (default: c(-200, 200))

apply_diffrange

logical value, if set to TRUE (default), the difference range criterion is applied.

diffrange_limit

numeric vector of length 2, the minimum and maximum voltage difference in a given interval (default: 200)

diffrange_mark

numeric vector of length 2; the placement of the Bad Interval mark in milliseconds before and after the occurence of diffrange_limit violation (default: c(-200, 200))

diffrange_interval

numeric value, the length of interval for the difference range criterion in milliseconds (default: 200)

apply_amplrange

logical value, if set to TRUE (default), the amplitude range criterion is applied.

amplrange_limit

numeric vector of length 2, the minimum and maximum voltage in the whole segment (default: c(-200, 200))

amplrange_mark

numeric vector of length 2; the placement of the Bad Interval mark in milliseconds before and after the occurence of amplrange_limit violation (default: c(-200, 200))

Details

The short definitions of the possible artifact rejection criteria are as follows:

Value

A list object with all parameters.

Note

The algorithm takes care of the sampling frequency for all parameters which are provided in milliseconds (or /ms) and makes adjustments if needed. However, *_mark parameters are not used since only segmented data can be analyzed in the present version of artifactRejection().


tdeenes/eegR documentation built on April 19, 2021, 4:17 p.m.