scrub_xifti: Scrub fMRI data in CIFTI format

View source: R/scrub.R

scrub_xiftiR Documentation

Scrub fMRI data in CIFTI format

Description

Performs projection scrubbing or DVARS scrubbing, and optionally thresholds to identify artifactual time points. Requires ciftiTools and the Connectome Workbench.

Usage

scrub_xifti(
  X,
  method = c("projection", "DVARS"),
  brainstructures = c("left", "right"),
  ...
)

Arguments

X

Path to a CIFTI file, or a "xifti" object.

method

"projection" or "DVARS"

brainstructures

Character vector indicating which brain structure(s) to use: "left" (left cortical surface), "right" (right cortical surface) and/or "subcortical" (subcortical and cerebellar gray matter). Can also be "all" (obtain all three brain structures). Default: c("left", "right") (excludes the subcortex).

...

Additional arguments to each specific scrubbing function: 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.