format_data: Format data for pscrub and CompCor
In fMRItools: Routines for Common fMRI Processing Tasks

format_data

R Documentation

Format data for pscrub and CompCor

Format data for pscrub and CompCor

format_data(
  X,
  ROI_data = "infer",
  ROI_noise = NULL,
  noise_nPC = 5,
  noise_erosion = NULL
)

`X`	description
`ROI_data`, `ROI_noise`	description
`noise_nPC`	The number of principal components to compute for each noise ROI. Alternatively, values between 0 and 1, in which case they will represent the minimum proportion of variance explained by the PCs used for each noise ROI. The smallest number of PCs will be used to achieve this proportion of variance explained. Should be a list or numeric vector with the same length as `ROI_noise`. It will be matched to each ROI based on the name of each entry, or if the names are missing, the order of entries. If it is an unnamed vector, its elements will be recycled. Default: `5` (compute the top 5 PCs for each noise ROI).
`noise_erosion`	The number of voxel layers to erode the noise ROIs by. Should be a list or numeric vector with the same length as `ROI_noise`. It will be matched to each ROI based on the name of each entry, or if the names are missing, the order of entries. If it is an unnamed vector, its elements will be recycled. Default: `NULL`, which will use a value of 0 (do not erode the noise ROIs).