carpetplot_stack

Stacks carpetplots on top of one another by rbinding the matrices.

Supports fMRI (functional magnetic resonance imaging)
analysis tasks including reading in 'CIFTI', 'GIFTI' and
'NIFTI' data, temporal filtering, nuisance regression, and
aCompCor (anatomical Components Correction) (Muschelli et al.
(2014) <doi:10.1016/j.neuroimage.2014.03.028>).

Amanda Mejia

fMRItools

Routines for Common fMRI Processing Tasks

Damon Pham

Mark Fiecas

carpetplot_stack function

<dl><dt>x_list</dt>
<dd>List of data matrices</dd>
<dt>center, scale</dt>
<dd>Center and scale the data? If <code>x</code> is fMRI data
which has not otherwise been centered or scaled, it is recommended to center
but not scale it (default).</dd>
<dt>qcut</dt>
<dd>Sets blackpoint at the <code>qcut</code> quantile, and the
whitepoint at the <code>1-qcut</code> quantile. Default: <code>.1</code>. This is
equivalent to setting the color range between the 10% and 90% quantiles.
The quantiles are computed across the entire data matrix after any
centering or scaling.
Must be between 0 and .49. If <code>0</code> or <code>NULL</code> (default), do not
clamp the data values.</dd>
<dt>match_scale</dt>
<dd>Match the scales of the carpetplots? Default: <code>TRUE</code>.</dd>
<dt>nsep</dt>
<dd>Equivalent number of data locations for size of gap between
carpetplots. Default: zero (no gap).</dd>
<dt>...</dt>
<dd>Additional arguments to <code>carpetplot</code></dd></dl>

Arguments

Stacked carpetplot — carpetplot_stack

<dl>

<dt>x_list</dt>
<dd>List of data matrices</dd>


<dt>center, scale</dt>
<dd>Center and scale the data? If <code>x</code> is fMRI data
which has not otherwise been centered or scaled, it is recommended to center
but not scale it (default).</dd>


<dt>qcut</dt>
<dd>Sets blackpoint at the <code>qcut</code> quantile, and the
whitepoint at the <code>1-qcut</code> quantile. Default: <code>.1</code>. This is
equivalent to setting the color range between the 10% and 90% quantiles.
The quantiles are computed across the entire data matrix after any
centering or scaling.
Must be between 0 and .49. If <code>0</code> or <code>NULL</code> (default), do not
clamp the data values.</dd>


<dt>match_scale</dt>
<dd>Match the scales of the carpetplots? Default: <code>TRUE</code>.</dd>


<dt>nsep</dt>
<dd>Equivalent number of data locations for size of gap between
carpetplots. Default: zero (no gap).</dd>


<dt>...</dt>
<dd>Additional arguments to <code>carpetplot</code></dd>

</dl>

carpetplot_stack: Stacked carpetplot

Description

Usage

Value

Arguments