fmri_mem_dataset: Create an fMRI Memory Dataset Object

In bbuchsbaum/fmrireg: R package for the anlysis of fmri data

Create an fMRI Memory Dataset Object

Description

This function creates an fMRI memory dataset object, which is a list containing information about the scans, mask, TR, number of runs, event table, base path, sampling frame, and censor.

Usage

fmri_mem_dataset(
  scans,
  mask,
  TR,
  run_length = sapply(scans, function(x) dim(x)[4]),
  event_table = data.frame(),
  base_path = ".",
  censor = NULL
)

Arguments

scans	A list of objects of class NeuroVec.
mask	A binary mask of class NeuroVol indicating the set of voxels to include in analyses.
TR	Repetition time (TR) of the fMRI acquisition.
run_length	A numeric vector specifying the length of each run in the dataset. Default is the length of the scans.
event_table	An optional data frame containing event information. Default is an empty data frame.
base_path	An optional base path for the dataset. Default is "." (current directory).
censor	An optional numeric vector specifying which time points to censor. Default is NULL.

Value

An fMRI memory dataset object of class c("fmri_mem_dataset", "volumetric_dataset", "fmri_dataset", "list").

Examples

# Create a NeuroVec object
d <- c(10, 10, 10, 10)
nvec <- neuroim2::NeuroVec(array(rnorm(prod(d)), d), space=neuroim2::NeuroSpace(d))

# Create a NeuroVol mask
mask <- neuroim2::NeuroVol(array(rnorm(10*10*10), d[1:3]), space=neuroim2::NeuroSpace(d[1:3]))
mask[mask < .5] <- 0

# Create an fmri_mem_dataset
dset <- fmri_mem_dataset(list(nvec), mask, TR=2)

# Create an iterator with 100 chunks
iter <- data_chunks(dset, nchunks=100)

bbuchsbaum/fmrireg documentation built on May 16, 2023, 10:56 a.m.