image.statMap: View statMap and pbj results in a statMap object

View source: R/statmap.R

image.statMapR Documentation

View statMap and pbj results in a statMap object

Description

Uses a statMap with inferences results to visualize CEI, CMI, or maxima

Usage

## S3 method for class 'statMap'
image(
  x,
  method = c("CEI", "maxima", "CMI"),
  cft_s = NULL,
  cft_p = NULL,
  cft_chisq = NULL,
  roi = NULL,
  index = NULL,
  alpha = NULL,
  clusterMask = TRUE,
  clusterID = TRUE,
  title = "",
  plane = c("axial", "sagittal", "coronal"),
  crop = TRUE,
  lo = TRUE,
  ...
)

Arguments

x

the statMap that created the pbj object.

method

Which inference method to visualize.

cft_s

The cluster forming threshold or threshold for visualizing results on the RESI effect size scale.

cft_p

The cluster forming threshold or threshold for visualizing results on the p-value scale.

cft_chisq

The cluster forming threshold or threshold for visualizing results on the chi-squared scale.

roi

Which ROI index to visualize.

index

Which slices to visualize. Default is all slices

alpha

Adjusted p-value threshold to display clusters.

clusterMask

logical indicating whether to mask the results with significant clusters.

clusterID

logical indicating whether to include the clusterID in the figure.

title

Character passed to image.niftiImage

plane

Which anatomical plane to visualize.

crop

Whether to crop white space from image. Defaults to TRUE.

lo

Whether to perform layout call to arrange images. Defaults to true.

...

Arguments passed to par.


simonvandekar/pbj documentation built on Nov. 3, 2023, 9:33 a.m.