write_surf_data: Write Surface Data to File

In bbuchsbaum/neurosurf: Data structures and visualization for surface-based neuroimaging data

Write Surface Data to File

Description

This function writes surface data from a NeuroSurface or NeuroSurfaceVector object to a .1D.dset file.

Usage

write_surf_data(surf, outstem, hemi = "")

Arguments

surf	An object of class NeuroSurface or NeuroSurfaceVector containing the surface data to be written.
outstem	A character string specifying the base name for the output file (without extension).
hemi	A character string specifying the hemisphere ("lh" for left, "rh" for right). Default is an empty string.

Details

The function writes the surface data to a .1D.dset file, which is a tabular data format. The output file contains node indices in the first column, followed by data values in subsequent columns. The file name is constructed by combining outstem, hemi (if provided), and the extension ".1D.dset". For NeuroSurfaceVector objects, all columns of data are written. For NeuroSurface objects, only the single data vector is written. The data is written without row names, column names, or quotes.

Value

This function does not return a value. It writes the data to a .1D.dset file as a side effect.

Examples

## Not run: 
# Assuming 'surf_data' is a NeuroSurface or NeuroSurfaceVector object
write_surf_data(surf_data, "output_data", "lh")
# This will create a file named "output_data_lh.1D.dset"

## End(Not run)

bbuchsbaum/neurosurf documentation built on June 10, 2025, 8:22 p.m.