plotData.statMap: Creates dataframes, emmeans, and models of the selected ROI...

View source: R/statmap.R

plotData.statMapR Documentation

Creates dataframes, emmeans, and models of the selected ROI data

Description

Returns a statistical niftiImage object from a statMap object

Usage

plotData.statMap(
  x,
  emForm = NULL,
  method = "CEI",
  cft_s = NULL,
  cft_p = NULL,
  cft_chisq = NULL,
  roiInds = NULL,
  ...
)

Arguments

x

the statMap object

emForm

a formula specifying how to plot the data

method

A character specifying which inference method to plot results for. One of maxima, CEI, or CMI

cft_s

cluster forming threshold on effect size scale.

cft_p

cluster forming threshold on p-value scale.

cft_chisq

cluster forming threshold on chi-square statistic scale.

roiInds

A numeric/integer vector specifying which ROIs to plot results for.

...

arguments passed to ref_grid

Details

Returns ROI summary results if pbjInference has been executed on the statMap object. If not, it attempts to create a cluster summary table based on the method and cft_* arguments. emmeans objects can be used for plotting and are returned if emForm is specified.

Value

a list with a dataframe containing the original data with a column added for mean ROI values for each subject, an emmeans objects based on the emForm argument, and model objects of the full model fit to each ROI.


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