R/vlmParam.R
vlmParam.RdThis function is able to run a Linear Model using the stats package. The analysis will run in all voxels in in the mask and will and will return parametric coefficients at each voxel.
vlmParam(image, mask, fourdOut = NULL, formula, subjData,
mc.preschedule = TRUE, ncores = 1, ...)Input image of type 'nifti' or vector of path(s) to images. If multiple paths, the script will all mergeNifti() and merge across time.
Input mask of type 'nifti' or path to mask. Must be a binary mask
To be passed to mergeNifti, This is the path and file name without the suffix to save the fourd file. Default (NULL) means script won't write out 4D image.
Must be a formula passed to lm()
Dataframe containing all the covariates used for the analysis
Argument to be passed to mclapply, whether or not to preschedule the jobs. More info in parallel::mclapply
Number of cores to use
Additional arguments passed to lm()
Return list of parametric and spline coefficients (include standard errors and p-values) fitted to each voxel over the masked images passed to function.
image <- oro.nifti::nifti(img = array(1:1600, dim =c(4,4,4,25)))
mask <- oro.nifti::nifti(img = array(0:1, dim = c(4,4,4,1)))
set.seed(1)
covs <- data.frame(x = runif(25), y = runif(25))
fm1 <- "~ x + y"
models <- vlmParam(image=image, mask=mask, formula=fm1, subjData=covs, ncores = 1)
#> [1] "Created time series to matrix"
#> [1] "Created formula list"
#> [1] "Running test model"
#> [1] "Running parallel models"
#> elapsed
#> 0.021
#> [1] "Parallel Models Ran"