fs_help: Wrapper for getting Freesurfer help

In freesurfer: Wrapper Functions for 'Freesurfer'

Wrapper for getting Freesurfer help

Description

This function takes in the function and returns the help from Freesurfer for that function

Usage

fs_help(func_name, help.arg = "--help", extra.args = "", ...)

Arguments

func_name	Freesurfer function name
help.arg	Argument to print help, usually "–help"
extra.args	Extra arguments to be passed other than --help
...	additional arguments to get_fs

Value

Prints help output and returns output as character vector

Examples

if (have_fs()) {
fs_help(func_name = "mri_watershed")
}

freesurfer documentation built on June 8, 2025, 10:17 a.m.