Plot a sampling_frame

Visualizes the runs of a sampling_frame (from fmrihrf) over time. Printing a sampling_frame is handled by fmrihrf's own print() method.

Usage

# S3 method for class 'sampling_frame'
plot(
  x,
  style = c("timeline", "grid", "lane"),
  show_ticks = FALSE,
  tick_every = 5,
  events = NULL,
  title = NULL,
  subtitle = NULL,
  ...
)

Arguments

x

A sampling_frame object created by fmrihrf::sampling_frame().

style

Plot style. One of "timeline" (default), "grid" or "lane". "timeline" draws one bar per run on a shared time axis; "grid" shows the scans of each run as cells on a within-run scan axis; "lane" is a compact single row of adjacent run segments, annotated above each segment.

show_ticks

Logical; whether to show per-TR tick marks along each run (timeline style only). Default FALSE.

tick_every

Integer; draw a tick every tick_every TRs when show_ticks = TRUE (timeline), or alternate cell shading every tick_every scans (grid; defaults to 10 for runs over 100 scans). Default 5.

events

Optional events to overlay as a coverage check: an event_model, or a data frame with an onset column (seconds, relative to the start of each run) and a run (or block) column. Each onset is drawn as a small tick under its run, so runs without events or with an empty tail stand out; onsets that fall outside their run are counted in the caption.

title, subtitle

Optional title and subtitle; the defaults describe the acquisition (runs, scans, TR, total duration).

...

Unused.

Value

A ggplot object.

Examples

sf <- fmrihrf::sampling_frame(blocklens = c(60, 120), TR = 2)
plot(sf)