fs_help: Wrapper for getting Freesurfer help

Description Usage Arguments Value Examples

View source: R/fs_help.R

Description

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

Usage

1
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

1
2
3
if (have_fs()) {
fs_help(func_name = "mri_watershed")
}

neuroconductor-devel/freesurfer documentation built on April 1, 2021, 1:07 p.m.