flatten_xifti: Flatten a '"xifti"'

View source: R/flatten_xifti.R

flatten_xiftiR Documentation

Flatten a "xifti"

Description

Concatenates the data in a "xifti" object row-wise to form a single matrix.

Usage

flatten_xifti(xifti, medial_wall = NULL, subcort_order = "alphabetical")

Arguments

xifti

A "xifti" object.

medial_wall

Should vertices for the medial wall be included with the cortical data? If NULL (default), do not include them. If any other value, use that value to fill rows corresponding to the medial wall mask.

subcort_order

"alphabetical" (default) to match the Connectome Workbench command -cifti-export-dense-mapping, or "spatial" which is already the ordering used in the "xifti".

Details

If all brain structures are present, and if is.null(medial_wall) and subcort_order=="alphabetical" (the default arguments), then the result will be identical to the matrix obtained with the Connectome Workbench command -cifti-export-dense-mapping.

Value

The flattened "xifti", a data matrix


mandymejia/ciftiTools documentation built on Feb. 28, 2024, 11:20 a.m.