summary: Compute summary statistics for 'arrayTtest', 'arrayAnova', or...

In tdeenes/eegR: Analyze EEG Signals

Description

summary.arrayTtest, summary.arrayAnova, and summary.tanova compute the minimum, maximum and median of criterion-referenced test statistics, effect sizes and P-values for particular subviews (e.g. channel X time subviews).

Usage

## S3 method for class 'arrayTtest'
summary(
  object,
  basis = c("p_corr", "p", "es", "stat", "stat_corr"),
  basis_dim = c("chan", "time"),
  crit = NULL,
  ...
)

## S3 method for class 'arrayAnova'
summary(
  object,
  basis = c("p_corr", "p", "es", "stat", "stat_corr"),
  basis_dim = c("chan", "time"),
  crit = NULL,
  ...
)

## S3 method for class 'tanova'
summary(
  object,
  basis = c("p_corr", "p", "stat", "stat_corr"),
  basis_dim = "time",
  crit = NULL,
  ...
)

Arguments

object	an object of class arrayTtest, arrayAnova, or tanova
basis	character value indicating the criterion node (default: "p_corr"), see Details
basis_dim	integer or character vector indicating the dimensions which form relevant subparts for which summary statistics should be computed (default: c("chan", "time"))
crit	numeric scalar, the level of criterion (see Details)
...	arguments passed to extract, e.g. time_window = c(100, 200)

Details

If 'basis' is "p_corr" (the default) or "p", denoting corrected and uncorrected P-values, respectively, argument 'crit' refers to the desired alpha-level (set to 0.05 by default). In this case the basis values should be below or equal to the criterion. If basis is "stat" (test statistic), "stat_corr" (corrected test statistic) or "es" (effect size), absolute basis values above or equal to the 'crit' criterion are selected.
The summary statistics are computed for those data points which correspond to the selected positions in the 'basis_dim' subviews. For example, supposing the object is the result of an uncorrected ANOVA calculation (see arrayAnova), and separate analyses were conducted for each channel X time data points but no other dimension, summary returns the list of min, max, and median of F-values and effect sizes (generalized eta squares) taking into consideration only those channel X time values for each model term, which were significant at the level of 0.05.
The returned list also contains the descriptive statistics of the selected P-values together with the number and ratio of significant values. Note that if no data points meet the given criterion in a particular subview, no summaries can be computed, resulting in NA values in the corresponding cells.

Value

The methods return a list of summaries which can be printed with the corresponding print method.

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