correlation_map.baseline_model: correlation_map.baseline_model

In bbuchsbaum/fmrireg: R package for the anlysis of fmri data

correlation_map.baseline_model

Description

Generates a correlation heatmap of the columns in a baseline_model's design matrix.

Usage

## S3 method for class 'baseline_model'
correlation_map(
  x,
  method = c("pearson", "spearman"),
  half_matrix = FALSE,
  absolute_limits = TRUE,
  ...
)

Arguments

x	A baseline_model.
method	Correlation method (e.g., "pearson", "spearman").
half_matrix	Logical; if TRUE, display only the lower triangle of the matrix.
absolute_limits	Logical; if TRUE, set color scale limits from -1 to 1.
...	Additional arguments passed to internal plotting functions.

Value

A ggplot2 plot object.

Examples

sframe <- fmrihrf::sampling_frame(blocklens = 5, TR = 1)
bmod <- baseline_model(sframe = sframe)
if (requireNamespace("ggplot2", quietly = TRUE)) correlation_map(bmod)

bbuchsbaum/fmrireg documentation built on June 10, 2025, 8:18 p.m.