new_best_hrf_result: Create a new "best_hrf_result" object

View source: R/find_hrf.R

new_best_hrf_resultR Documentation

Create a new "best_hrf_result" object

Description

This constructor wraps up the result from find_best_hrf into a proper S3 class with a pretty print method.

Usage

new_best_hrf_result(
  best_hrf_indices = NULL,
  clusters = NULL,
  cluster_representatives = NULL,
  reassigned_hrfs = NULL,
  L_best_hrfs = NULL,
  L_unique = NULL,
  L_proj = NULL,
  X_proj = NULL,
  reassigned_hrfs_smoothed = NULL
)

Arguments

best_hrf_indices

numeric vector of unique best HRFs

clusters

integer vector of clusters assigned to each unique HRF

cluster_representatives

integer vector of cluster medoids

reassigned_hrfs

integer vector of HRF IDs assigned to each voxel

L_best_hrfs

matrix of all best HRFs found

L_unique

matrix of unique HRFs (one per cluster/representative)

L_proj

matrix of the library projected into data space

X_proj

matrix of the data projection

reassigned_hrfs_smoothed

optionally the smoothed HRF assignments

Value

An object of class "best_hrf_result".


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