images

A 'ggplot2'-consistent approach to generating 2D displays of  volumetric brain imaging data.
Display data from multiple NIfTI images using standard 'ggplot2' conventions such scales, limits, and
themes to control the appearance of displays. The resulting plots are returned as 'patchwork' objects,
inheriting from 'ggplot', allowing for any standard modifications of display aesthetics supported by 'ggplot2'.

Michael Hallquist

ggbrain

Create Images of Volumetric Brain Data in NIfTI Format Using
'ggplot2' Syntax

images function

<dl><dt>images</dt>
<dd>a character vector or ggbrain_images object containing NIfTI images to add to this plot</dd>
<dt>volumes</dt>
<dd>a number indicating the volume within the <code>images</code> to display. At present, this must
be a single number -- perhaps in the future, it could be a vector so that many timepoints in a 4-D image could
be displayed.</dd>
<dt>labels</dt>
<dd>a data.frame or named list of data.frame objects corresponding to images that should be labeled.
You can only provide a data.frame if there is a single image being added. If multiple images are added, the names of
the <code>labels</code> list are used to align the labels with a given matching image.</dd>
<dt>filter</dt>
<dd>a named list or character string specifying an expression of values to retain in the image,
or a numeric vector of values to retain. Calls ggbrain_images$filter_image()</dd></dl>

Arguments

Add images to a ggbrain object — images

<dl>

<dt>images</dt>
<dd>a character vector or ggbrain_images object containing NIfTI images to add to this plot</dd>


<dt>volumes</dt>
<dd>a number indicating the volume within the <code>images</code> to display. At present, this must
be a single number -- perhaps in the future, it could be a vector so that many timepoints in a 4-D image could
be displayed.</dd>


<dt>labels</dt>
<dd>a data.frame or named list of data.frame objects corresponding to images that should be labeled.
You can only provide a data.frame if there is a single image being added. If multiple images are added, the names of
the <code>labels</code> list are used to align the labels with a given matching image.</dd>


<dt>filter</dt>
<dd>a named list or character string specifying an expression of values to retain in the image,
or a numeric vector of values to retain. Calls ggbrain_images$filter_image()</dd>

</dl>

images: Add images to a ggbrain object

Description

Usage

Value

Arguments

Examples