format_design: Format design

View source: R/check_data_inputs.R

format_designR Documentation

Format design

Description

Format design for BayesGLM, fit_bayesglm, multiGLM, and multiGLM_fun.

Usage

format_design(
  design,
  scale_design = TRUE,
  nS_expect = NULL,
  nT_expect = NULL,
  nD_expect = NULL,
  per_location_design = NULL
)

Arguments

design

The design argument input. Will be formatted to a nS-length list.

scale_design

Scale the design matrix by dividing each column by its maximum and then subtracting the mean? Default: TRUE. If FALSE, the design matrix is centered but not scaled.

nS_expect

The expected number of sessions, if known.

nT_expect

The expected number of timepoints, if known. For multi-session data this is a session-length vector.

nD_expect

The expected number of designs, if known. For per-location modeling this is equal to nVd0, the initial number of data locations. For multi-session data this is a session-length vector.

per_location_design

FALSE if per-location modeling is not being performed (i.e. for multiGLM); TRUE if it is; or, NULL to infer based on the dimensions of design (TRUE if the design has three dimensions.)

Value

design


hrf documentation built on April 3, 2025, 10:36 p.m.