Skip to contents

Reads a dataset from an HDF5 file with automatic type detection. The function examines the file structure to determine the appropriate object type and returns the corresponding fmristore object.

Usage

# S4 method for class 'character'
read_dataset(x, type = NULL, ...)

Arguments

type

Optional character string specifying the expected type. If NULL (default), the type is auto-detected.

...

Additional arguments passed to the object constructor

file

Path to HDF5 file

Value

An fmristore object of the appropriate type: - H5NeuroVol for 3D volumes - H5NeuroVec for 4D time series - H5NeuroVecSeq for sequences of 4D data - H5ParcellatedMultiScan for parcellated experiments - LatentNeuroVec for latent representations - LabeledVolumeSet for labeled regions

Examples

if (FALSE) { # \dontrun{
# Auto-detect type
obj <- read_dataset("data.h5")

# Specify type explicitly
obj <- read_dataset("data.h5", type = "H5NeuroVec")

# Pass additional arguments to constructor
obj <- read_dataset("data.h5", dataset_name = "processed")
} # }