Annotate orientation labels (L/R/A/P/S/I) on each panel using NIfTI header info

Usage

annotate_orientation(size = 3, color = NULL, offset = 0, show = "all", ...)

Arguments

size: Text size passed to ggplot2::annotate
color: Text color passed to ggplot2::annotate. If NULL, defaults to the panel text color.
offset: Offset to nudge labels away from the image edge. Can be scalar or length 4 (left, right, bottom, top). Numeric values are in data units; percentage strings (e.g., "10%") are interpreted relative to the panel width (left/right) or height (bottom/top).
show: Character vector of labels to display. Valid values are any of c("A","P","I","S","L","R") or "All" (default) to show all labels.
...: Additional arguments passed to ggplot2::annotate (e.g., fontface)

Value

a ggb object with action "add_annotations"

Details

Uses RNifti::orientation on the first image in the ggbrain object (cached in the slices object) to infer axis labels and places them along the edges of each panel. If orientation cannot be determined, no annotations are added.