get.mmdt.obj: Get Multi-Modal Density Test Object

Description Usage Arguments Value Examples

View source: R/get.mmdt.obj.R

Description

This function creates an mmdt object from lists of nifti filenames.

Usage

1
2
3
get.mmdt.obj(masks, modal1, modal2, modal3 = NULL, modal4 = NULL,
  modal5 = NULL, modal6 = NULL, ids, groups, parallel = TRUE,
  cores = 2, pb = TRUE)

Arguments

masks

a vector of class character that gives .nii or .nii.gz filenames for subjects' masks. Masks will demarcate which voxels will be included in the analysis, and should be coded by TRUE/FALSE or 1/0.

modal1

vector of class character that give .nii or .nii.gz filenames for a given imaging modality across subjects. At least two modalities (modal1 and modal2) must be entered. Up to 6 can be included.

modal2

see 'modal1' description

modal3

see 'modal1' description

modal4

see 'modal1' description

modal5

see 'modal1' description

modal6

see 'modal1' description

ids

a vector of subject ids. Must be the same length as the filenames in the 'modal#' vectors.

groups

a vector of group membership. Must be two categories, and should be the same length as 'ids'.

parallel

is a logical value that indicates whether the user's computer is Linux or Unix (i.e. macOS), and should run the code in parallel.

cores

if parallel = TRUE, cores is an integer value that indicates how many cores the function should be run on.

pb

is a logical value that indicates whether or not a progress bar will be shown during analysis.

Value

An mmdt object to be used in the 'mmdt' function.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
masks = c("mask01.nii", "mask02.nii", "mask03.nii", "mask04.nii")
t1s = c("t101.nii", "t102.nii", "t103.nii", "t104.nii")
flairs = c("flair01.nii", "flair02.nii", "flair03.nii", "flair04.nii")
ids = c(1, 2, 3, 4)
groups = c(1, 1, 2, 2)

mmdt.obj = get.mmdt.obj(masks = masks, modal1 = t1s, modal2 = flairs,
                        ids = ids, groups = groups)
## End(Not run)

jdwor/mmdt documentation built on April 7, 2021, 5:17 p.m.