fcComBat: Functional connectivity ComBat

View source: R/fcComBat.R

fcComBatR Documentation

Functional connectivity ComBat

Description

Functional connectivity ComBat

Usage

fcComBat(
  x,
  bat,
  eb = TRUE,
  mod = NULL,
  to.corr = TRUE,
  out.pd = FALSE,
  fisher = TRUE
)

Arguments

x

p x p x n covariance or correlation matrices where p is the number of ROIs and n is the number of subjects.

bat

Factor (or object coercible by as.factor to a factor) of length n designating batch IDs.

eb

If 'TRUE“, uses ComBat model with empirical Bayes for mean and variance harmonization.

mod

Optional design matrix of covariates to preserve, usually from the output of model.matrix.

to.corr

If TRUE, uses cov2cor to convert input matrices into correlation matrices

out.pd

Whether input should be forced to be positive definite using nearPD. This step is unnecessary for many downstream network analyses so defaults to FALSE.

fisher

Whether to Fisher-transform the off-diagonal elements before applying CovBat, highly recommended that this be set to TRUE.


andy1764/FCHarmony documentation built on April 4, 2022, 10:41 a.m.