format_design

Format design for <code>BayesGLM</code>, <code>fit_bayesglm</code>,
<code>multiGLM</code>, and <code>multiGLM_fun</code>.

internal

Computes the hemodynamic response function (HRF) for task
functional magnetic resonance imaging (fMRI) data. Also includes functions
for constructing a design matrix from task fMRI event timings, and for
comparing multiple design matrices in a general linear model (GLM). A
wrapper function is provided for GLM analysis of CIFTI-format data. Lastly,
there are supporting functions which provide visual summaries of the
HRFs and design matrices.

Amanda Mejia

Hemodynamic Response Function

Damon Pham

David Bolin

Yu (Ryan) Yue

Daniel Spencer

Sarah Ryan

format_design function

<dl><dt>design</dt>
<dd>The <code>design</code> argument input. Will be formatted to a
<code>nS</code>-length list.</dd>
<dt>scale_design</dt>
<dd>Scale the design matrix by dividing each column by its
maximum and then subtracting the mean? Default: <code>TRUE</code>. If
<code>FALSE</code>, the design matrix is centered but not scaled.</dd>
<dt>nS_expect</dt>
<dd>The expected number of sessions, if known.</dd>
<dt>nT_expect</dt>
<dd>The expected number of timepoints, if known. For
multi-session data this is a session-length vector.</dd>
<dt>nD_expect</dt>
<dd>The expected number of designs, if known. For per-location
modeling this is equal to <code>nVd0</code>, the initial number of data locations.
For multi-session data this is a session-length vector.</dd>
<dt>per_location_design</dt>
<dd><code>FALSE</code> if per-location modeling is not
being performed (i.e. for multiGLM); <code>TRUE</code> if it is; or, <code>NULL</code>
to infer based on the dimensions of <code>design</code> (<code>TRUE</code> if the
design has three dimensions.)</dd></dl>

Arguments

Format design — format_design

<dl>

<dt>design</dt>
<dd>The <code>design</code> argument input. Will be formatted to a
<code>nS</code>-length list.</dd>


<dt>scale_design</dt>
<dd>Scale the design matrix by dividing each column by its
maximum and then subtracting the mean? Default: <code>TRUE</code>. If
<code>FALSE</code>, the design matrix is centered but not scaled.</dd>


<dt>nS_expect</dt>
<dd>The expected number of sessions, if known.</dd>


<dt>nT_expect</dt>
<dd>The expected number of timepoints, if known. For
multi-session data this is a session-length vector.</dd>


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


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

</dl>

format_design: Format design

Description

Usage

Value

Arguments