extract: Extract slots from arrayAnova, arrayTtest, or tanova object

In tdeenes/eegR: Analyze EEG Signals

Description

extract is a generic function for extracting slots from arrayTtest, arrayAnova, or tanova objects, each produced by the corresponding function.

Usage

extract(...)

## S3 method for class 'arrayTtest'
extract(
  object,
  what = c("all", "stat", "p", "es", "stat_corr", "p_corr", "means", "df"),
  time_window = NULL,
  term = NULL,
  chan = NULL,
  drop = FALSE,
  ...
)

## S3 method for class 'arrayAnova'
extract(
  object,
  what = c("all", "stat", "p", "es", "stat_corr", "p_corr", "means", "df"),
  time_window = NULL,
  term = NULL,
  chan = NULL,
  drop = FALSE,
  ...
)

## S3 method for class 'tanova'
extract(
  object,
  what = c("all", "stat", "p", "stat_corr", "p_corr", "means"),
  time_window = NULL,
  term = NULL,
  drop = FALSE,
  ...
)

Arguments

...	not used yet
object	an object of class arrayTtest, arrayAnova, or tanova
what	a character vector indicating which slot(s) to extract. If 'what' is 'all' (default), all relevant slots is extracted (see the Usage section for the relevant slot names in each particular method). Otherwise, the slots to extract are found by partial matching to the following choices: stat: Test statistic (e.g. F values in arrayAnova) stat_corr: Corrected test statistic (e.g. TFCE values in arrayAnova) p: Uncorrected P-values p_corr: Corrected P-values (e.g. TFCE-corrected P-values in arrayAnova, or minimum duration correction in tanova) es: Effect size statistic (e.g. Generalized Eta Squared in arrayAnova) means: Marginal means for each model term (TODO! Temporarily removed...)
time_window	numeric vector of length two indicating the time window which should be extracted. If NULL (default), all time points are returned.
term	character vector indicating the name of the model terms which should be extracted. If NULL (default), all model terms are returned.
chan	character or integer indices of channels to extract. If NULL (default), all channels are returned.
drop	logical value; if TRUE, singleton dimensions are dropped from the arrays after subsetting on time, term, and/or chan (default: FALSE)

Value

The function returns an array of the requested component or a named list of arrays if multiple components were requested.

Methods (by class)

• arrayTtest: Method for arrayTtest objects

• arrayAnova: Method for arrayAnova objects

• tanova: Method for tanova objects

See Also

See the examples of arrayAnova

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