Skip to contents

Element metadata from a ModelArray

elementMetadata.Rd

Reads element metadata (e.g., greyordinates for CIFTI data, or fixel/voxel coordinate information) from the HDF5 file if present. The function searches for known metadata dataset names ("greyordinates", "fixels", "voxels") at the top level of the HDF5 file.

Usage

elementMetadata(x)

# S4 method for class 'ModelArray'
elementMetadata(x)

Arguments

x

A ModelArray object.

Value

A matrix or data.frame of element metadata if found, or NULL if no known metadata dataset exists in the HDF5 file.

See also

nElements, scalars

Examples

if (FALSE) { # \dontrun{
ma <- ModelArray("data.h5", scalar_types = c("FD"))
meta <- elementMetadata(ma)
if (!is.null(meta)) head(meta)
} # }