correlation_map.event_model: correlation_map.event_model

View source: R/event_model.R

correlation_map.event_modelR Documentation

correlation_map.event_model

Description

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

Usage

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

Arguments

x

An event_model.

method

Correlation method, "pearson" or "spearman".

half_matrix

Logical; if TRUE, mask out the upper-triangle.

absolute_limits

Logical; if TRUE, fix color scale to -1..+1.

...

Further arguments passed to .correlation_map_common.


bbuchsbaum/fmrireg documentation built on March 1, 2025, 11:20 a.m.