cluster_peaks: Compute cluster peaks.

In dfsp-spirit/brainloc: Find Region Names and Coordinates for a Point on the Human Brain

Description

A peak is a position in a cluster (a vertex) which is assigned the maximum statsmap value over its neighborhood. The neighborhood definition used by this function is the 1-ring neighborhood on the mesh.

Usage

cluster_peaks(
  clusterinfo,
  type = "extreme",
  silent = getOption("brainloc.silent", default = FALSE),
  ...
)

Arguments

clusterinfo	a clusterinfo instance, see the clusterinfo function to get one.
type	character string, one of 'extreme', 'min' or 'max'. Which cluster value to report. The default of 'extreme' reports the absolutely larger one of the min and the max value and is for the typical use case of t-value maps.
silent	whether to suppress printing messages to stdout.
...	passed on to clusteroverlay_to_annot.

Value

a data.frame with cluster peak information. The column names should be self-explanatory.

dfsp-spirit/brainloc documentation built on Jan. 28, 2022, 12:25 p.m.