ModelArray class

A ModelArray wraps one or more element-wise scalar matrices (e.g., FD, FC, log_FC for fixel data) read lazily via DelayedArray, along with any previously saved analysis results. The object holds references to the underlying HDF5 file and reads data on demand, making it suitable for large-scale neuroimaging datasets.

Prints a summary of the ModelArray including file path, scalar dimensions, and any saved analysis names.

Usage

ModelArray(filepath, scalar_types = c("FD"), analysis_names = character(0))

# S4 method for class 'ModelArray'
show(object)

Arguments

object

A ModelArray object.

Value

Invisible NULL. Called for its side effect of printing to the console.

Details

ModelArray is an S4 class that represents element-wise scalar data and associated statistical results backed by an HDF5 file on disk.

Each scalar in the HDF5 file is stored at /scalars/<name>/values as a matrix of elements (rows) by source files (columns). Source filenames are read from HDF5 attributes or companion datasets. Analysis results, if present, live under /results/<analysis_name>/results_matrix.

ModelArray objects are typically created with the ModelArray constructor function. Element-wise models are fit with ModelArray.lm, ModelArray.gam, or ModelArray.wrap.

Slots

sources

A named list of character vectors. Each element corresponds to a scalar and contains the source filenames (one per input file/subject).

scalars

A named list of DelayedArray::DelayedArray matrices. Each matrix has elements as rows and source files as columns.

results

A named list of analysis results. Each element is itself a list containing at minimum results_matrix (a DelayedArray::DelayedArray).

path

Character. Path(s) to the HDF5 file(s) on disk.

See also

ModelArray for the constructor, ModelArray.lm, ModelArray.gam, ModelArray.wrap for analysis, scalars, sources, results for accessors.