ciftiTools (version 0.1.6.0)

write_cifti_components: Write CIFTI component files from a "xifti" object.

Description

Write metric GIFTIs for the cortical surface data and NIFTIs for the subcortical labels and mask in a "xifti" object. Each present brainstructure will be written; if a brainstructure is absent the corresponding file is not written.

Usage

write_cifti_components(
  xifti,
  extn_cifti,
  write_dir = NULL,
  mwall_fill = NA,
  subcort_fill = 0,
  verbose = FALSE,
  wb_path = NULL
)

Arguments

xifti

Object of class "xifti". See is.xifti and make_xifti.

extn_cifti

The CIFTI extension e.g. "dtseries.nii"

write_dir

Where should the separated files be placed? NULL (default) will write them to the current working directory.

write_dir must already exist, or an error will occur.

mwall_fill

Value to use for the medial wall in the cortex GIFTIs. Default: NA.

subcort_fill

Value to use for out-of-mask voxels in the subcortex. Default: 0.

verbose

Should occasional updates be printed? Default: FALSE.

wb_path

(Optional) Path to Connectome Workbench folder or executable. If not provided, should be set with ciftiTools.setOption("wb_path", "path/to/workbench").

Value

List of written files