voxel_stats: Run statistical tests on voxel-based heatmaps

View source: R/voxel_stats.R

voxel_statsR Documentation

Run statistical tests on voxel-based heatmaps

Description

Generate statistical outputs from voxel-based heatmaps created by voxelize(). Statistical output resembles input heatmaps, with green/red colors specifying locations where voxels show statistically significant differences between groups.

Usage

voxel_stats(
  input,
  group_matrices,
  groups = c(),
  ML_bounds = c(-5, 5),
  DV_bounds = c(-8, 1),
  p_value = 0.05,
  output
)

Arguments

input

(required) Specify path to input .RData file containing the group matrix.

group_matrices

(required) Specify object name for matrix of groups.

groups

(required, default = c()) Vector of 2 groups to be compared.

ML_bounds

(optional, default = c(-5, 5)) Bounds for ML axis.

DV_bounds

(optional, default = c(-8, 1)) Bounds for DV axis.

p_value

(optional, default = 0.05) P-value threshold for significance.

output

(required) Specify path to output folder to save heatmap and .RData output.

Value

Returns stat_matrix an object containing a matrix with statistical test output (-1 for significantly lower, 0 for no significance, 1 for significantly higher).


jdknguyen/SMART documentation built on May 30, 2022, 10:51 p.m.