spm12_contrast_query: Build contrasts query for SPM12 results

Description Usage Arguments Value Examples

View source: R/spm12_contrast_query.R

Description

Build contrasts query for SPM12 results

Usage

1
2
3
4
5
6
7
spm12_contrast_query(weights = Inf, name = "",
  threshold_type = c("FWE", "none", "FDR"), threshold = 0.05,
  number_extent_voxels = 0, mask_type = c("None", "Contrast", "Image"),
  mask_image = NULL, mask_contrast = NULL, mask_threshold = 0.05,
  mask_inclusive = TRUE)

spm12_contrast_query_list(cons)

Arguments

weights

Weights of the contrast, must be the same length as the number of regressors

name

Name of the contrast

threshold_type

type of thresholding done, if any

threshold

Threshold value

number_extent_voxels

Number of voxel extent to call an area a cluster

mask_type

type of mask, if any

mask_image

If mask_type = "Image", then the filename of the mask

mask_contrast

Vector of weights for the contrast that will be used as the mask if mask_type = "Contrast"

mask_threshold

if mask_type = "Contrast", the threshold for the mask

mask_inclusive

Is the mask inclusive? If FALSE, then values in the mask which are zero will be included in the output

cons

List of contrasts

Value

A list of objects, each with a titlestr (title string), contrast, threshold description, threshold value, extent of voxels, and a mask (if appropriate)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
res = spm12_contrast_query(name = "condition1", weights = 1)
print(res)
contrasts = list(
list(name = "All Contrasts",
       weights = Inf
       ),
list(name = "RightHand",
weights = 2) 
)
res = spm12_contrast_query_list(contrasts)
print(res)

neuroconductor-devel/spm12r documentation built on May 6, 2021, 1:52 p.m.