summary.vw_fastlm: Summarize qdecr_fastlm clusters

In slamballais/QDECR: Vertex-wise statistical analysis

Description

Summarizes the significant clusters obtained from qdecr_fastlm

Usage

## S3 method for class 'vw_fastlm'
summary(
  object,
  verbose = FALSE,
  annot = FALSE,
  file = "aparc.annot",
  regions = 3,
  ...
)

Arguments

object	The output object of a qdecr call (e.g. qdecr_fastlm)
verbose	Logical; if TRUE, it outputs some information of the steps; default is FALSE
annot	Logical; if TRUE, 'file' will be read in to obtain information on the top regions in that cluster
file	string; the name of the file within the target template's label directory if annot = TRUE
regions	integer; number of regions that should be added if annot = TRUE
...	Further arguments for 'summary'

Details

This function returns an overview of the significant clusters from qdecr_fastlm, and provides information per cluster. Additionally, it is possible to obtain annotated information, given that it is located in the target template's label directory.

slamballais/QDECR documentation built on Jan. 9, 2022, 1:22 p.m.