scrub_plot: '"scrub"' plot sub-function

View source: R/plot.R

scrub_plotR Documentation

"scrub" plot sub-function

Description

Plot outlyingness measure(s) with the corresponding threshold(s). Requires the cowplot and ggplot2 packages

Usage

scrub_plot(
  meas,
  cut = NULL,
  flag_intersect = FALSE,
  colors = NULL,
  log_y = FALSE,
  geom = "point",
  ylim_min = 0,
  ylim_max = max(meas$measure),
  ...
)

Arguments

meas

A T by m numeric data.frame with each column being the timecourse for an outlyingness measure. The names of the columns will be used to label the plot.

cut

A length m numeric vector with each value being the cutoff for an outlyingness measure (each column in meas).

flag_intersect

Only flag timepoints at which all measures are outliers? Default: FALSE.

colors

A length m character vector giving the colors of each measure (each column in meas)

log_y

Use log scale for y-axis? Default: FALSE

geom

"point" (default) or "line"

ylim_min, ylim_max

The range of the y-axis.

...

Additional arguments to ggplot: main, sub, xlab, ...

Value

A ggplot


fMRIscrub documentation built on Oct. 25, 2023, 9:07 a.m.