scrub: Data-driven scrubbing

View source: R/scrub.R

scrubR Documentation

Data-driven scrubbing

Description

Performs projection scrubbing or DVARS scrubbing, and optionally thresholds to identify artifactual time points.

Usage

scrub(X, method = c("projection", "DVARS"), ...)

Arguments

X

A T by V numeric matrix representing an fMRI run. There should not be any missing data (NA or NaN).

method

"projection" (default) or "DVARS"

...

Additional arguments to the specific scrubbing function: see pscrub or DVARS.

Value

A list with components

measure

A length T vector or data.frame with T rows, giving the outlyingness measure(s)

measure_info

Describes the outlyingness measure(s)

outlier_cutoff

The outlier cutoff value(s).

outlier_flag

A length T vector or data.frame with T rows, where TRUE indicates suspected outlier presence.


fMRIscrub documentation built on Oct. 25, 2023, 9:07 a.m.