ciftiTools (version 0.9.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
)
writeCIfTI(
  xifti,
  cifti_fname,
  surfL_fname = NULL,
  surfR_fname = NULL,
  verbose = TRUE
)
writecii(
  xifti,
  cifti_fname,
  surfL_fname = NULL,
  surfR_fname = NULL,
  verbose = TRUE
)
write_xifti(
  xifti,
  cifti_fname,
  surfL_fname = NULL,
  surfR_fname = NULL,
  verbose = TRUE
)

Arguments

xifti

A "xifti" object.

cifti_fname

File path to a CIFTI file (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.

Value

Named character vector of the written files

Connectome Workbench

This function interfaces with the "-cifti-create-dense-timeseries", "-cifti-create-dense-scalar", or "-cifti-create-label" Workbench Command, depending on the input.

See Also

Other commonly-used functions: is.cifti(), read_cifti(), resample_cifti(), smooth_cifti(), view_xifti_surface(), view_xifti_volume()

Other functions for writing CIFTI or GIFTI data: separate_cifti(), write_metric_gifti(), write_subcort_nifti(), write_surf_gifti()