run.afni_lm_spec: Run an afni_lm_spec object

In bbuchsbaum/fmrireg: R package for the anlysis of fmri data

Run an afni_lm_spec object

Description

This function runs the 3dDeconvolve command for the specified afni_lm_spec object. It outputs the results to a specified directory and can either execute the command or only output the shell '3dDeconvolve.sh' script.

Usage

## S3 method for class 'afni_lm_spec'
run(x, outdir, execute = TRUE, execfun = system, prepend = "", ...)

Arguments

x	An afni_lm_spec object containing the model, dataset, and options
outdir	The output folder
execute	Whether to execute the command or only output the shell '3dDeconvolve.sh' script (default is TRUE)
execfun	Function used to execute external system command (default is system)
prepend	Prepend string to command (default is an empty string)
...	Additional arguments passed to execfun

Value

NULL. The function is used for its side effects, such as writing output files.

Examples

# Assuming you have created an afni_lm_spec object called alm
run.afni_lm_spec(alm, outdir="results")

bbuchsbaum/fmrireg documentation built on May 16, 2023, 10:56 a.m.