update.icac: Update the correction performed by function 'icac'.

In icaOcularCorrection: Independent Components Analysis (ICA) based artifact correction.

Description

The function takes an icac object as returned by the function of the same name and updates the correction as specified in argument what. Returns an icac object with the same slots as function icac does.

Usage

## S3 method for class 'icac'
update(object, what, verbosity = 2,
...)

Arguments

object	An icac object as returned by the function of the same name.
what	Either a named three-element vector or a list of two-element vectors. In the first case, the first element should be "trial", the trial at which the user wishes to add/subtract an IC, then "ic", the IC which the user wishes to add/subtract, and finally "operation", the operation to perform, either "+" or "-" (put back or zero-out if method = "zero-out". In the second case, this argument should be a list containing named two-element vectors (one or more). The first element of each vector should be the number corresponding to the IC that will operated on; the second element should be the operation to perform on the whole IC (put back, "+", or zero-out, "-").
verbosity	Numeric. The amount of information printed to screen during the modeling process. The higher the number, the more information is printed. 0 turns this option off. Defaults to 2. Maximum value is 2.
...	Unused.

Value

An updated icac object with slots:

x	The corrected data.
channel	The channels that were corrected.
noise.sig	The noise signals for which the data were corrected.
threshold	The correlation threshold above which the EEG/MEG data will be corrected.
n.comp	The number of independent components used in the ICA.
S	The updated (corrected) estimated source matrix.
A	The estimated mixing matrix.
W	The estimated un-mixing matrix.
K	pre-whitening matrix that projects data onto th first n.comp principal components.
S0	The un-updated estimated source matrix of the "icac" object passed to function update.icac.
col.means	the mean of each channel.
correlations	For each noise signal and each trial, the correlation between the IC and the noise signal.
correction.info	A data frame with columns "NoiseSignal" (the noise signal with which ICs were compared), "IC" (the IC which correlated above threshold with the noise signal), "Trial" (the trial at which the noise signal and the IC correlated above threshold), and "Corr" (the correlation between the noise signal and the IC).
method	The method used for correcting.
updated	List. The first time an "icac" object is updated, a new slot "updated" is created containing the values in argument "what". Slot "updated" will be appended with the new values passed to argument "what" upon subsequent updates.
proctime	If proctime = TRUE when running function icac, a data frame with processing time information.

Author(s)

Antoine Tremblay, Dalhousie University, [e-mail]

See Also

fastICA; icac; mwd.thrsh; plot_avgba; plot_trba; plot_nic; plot_tric; summary.icac; topo_ic.

Examples

### See vignette for examples.

Example output

Loading required package: fastICA
Loading required package: mgcv
Loading required package: nlme
This is mgcv 1.8-27. For overview type 'help("mgcv-package")'.

icaOcularCorrection documentation built on May 29, 2017, 1:53 p.m.