ciftiTools (version 0.1.6.0)

write_cifti: Write a CIFTI file from a "xifti" object.

Description

Write out a "xifti" object as a CIFTI file and (optionally) GIFTI surface files.

Usage

write_cifti(
  xifti,
  cifti_fname,
  surfL_fname = NULL,
  surfR_fname = NULL,
  verbose = TRUE,
  wb_path = NULL
)
writeCIfTI(
  xifti,
  cifti_fname,
  surfL_fname = NULL,
  surfR_fname = NULL,
  verbose = TRUE,
  wb_path = NULL
)
writecii(
  xifti,
  cifti_fname,
  surfL_fname = NULL,
  surfR_fname = NULL,
  verbose = TRUE,
  wb_path = NULL
)
write_xifti(
  xifti,
  cifti_fname,
  surfL_fname = NULL,
  surfR_fname = NULL,
  verbose = TRUE,
  wb_path = NULL
)

Arguments

xifti

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

cifti_fname

File path of CIFTI-format data (ending in ".d*.nii").

surfL_fname, surfR_fname

If the [left/right] surface is present, it will be a written to a GIFTI file at this file path. If NULL (default), do not write out the surface.

verbose

Should occasional updates be printed? Default: TRUE.

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

Named character vector of the written files

Connectome Workbench Requirement

This function uses a system wrapper for the 'wb_command' executable. The user must first download and install the Connectome Workbench, available from https://www.humanconnectome.org/software/get-connectome-workbench . The wb_path argument is the full file path to the Connectome Workbench folder. (The full file path to the 'wb_cmd' executable also works.)