Learn R Programming

freesurferformats (version 1.1.0)

cifti.validate.indices.map: Validate a parsed CIFTI MatrixIndicesMap.

Description

Check that the mapping is consistent with the size of the matrix dimension it describes, and that the index ranges it declares are valid. These checks exist because a mismatch would silently misalign the data.

Usage

cifti.validate.indices.map(map, filepath = "")

Value

NULL, invisibly. Stops with a descriptive error if the mapping is inconsistent.

Arguments

map

a parsed indices map, see cifti.parse.indices.map.

filepath

character string, the file path, used in error messages.