data_chunks.matrix_dataset: Create Data Chunks for matrix_dataset Objects

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

Create Data Chunks for matrix_dataset Objects

Description

This function creates data chunks for matrix_dataset objects. It allows for the retrieval of run-wise or sequence-wise data chunks, as well as arbitrary chunks.

Usage

## S3 method for class 'matrix_dataset'
data_chunks(x, nchunks = 1, runwise = FALSE, ...)

Arguments

x	An object of class 'matrix_dataset'.
nchunks	The number of data chunks to create. Default is 1.
runwise	If TRUE, the data chunks are created run-wise. Default is FALSE.
...	Additional arguments.

Value

A list of data chunks, with each chunk containing the data, voxel indices, row indices, and chunk number.

Examples

# Create a matrix_dataset
# ... (see example for matrix_dataset)

# Create an iterator with 5 chunks
iter <- data_chunks(dset, nchunks=5)
`%do%` <- foreach::`%do%`
y <- foreach::foreach(chunk = iter) %do% { colMeans(chunk$data) }
length(y) == 5

# Create an iterator with 100 chunks
iter <- data_chunks(dset, nchunks=100)
y <- foreach::foreach(chunk = iter) %do% { colMeans(chunk$data) }
length(y) == 100

# Create a "runwise" iterator
iter <- data_chunks(dset, runwise=TRUE)
y <- foreach::foreach(chunk = iter) %do% { colMeans(chunk$data) }
length(y) == 2

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