Skip to contents

Plot mnirs objects

Source: R/plot.mnirs.R
plot.mnirs.Rd

Create a base plot for data frames or lists of data frames with class "mnirs".

Usage

# S3 method for class 'mnirs'
plot(
  x,
  points = FALSE,
  time_labels = FALSE,
  n.breaks = 5,
  na.omit = FALSE,
  ...
)

Arguments

x

Data frame or list of data frames of class "mnirs" (e.g. from extract_intervals()). List input produces a faceted plot with one panel per element.

points

Logical. Default is FALSE. If TRUE displays ggplot2::geom_points(). Otherwise displays ggplot2::geom_lines().

time_labels

Logical. Default is FALSE. If TRUE displays x-axis time values formatted as "hh:mm:ss" using format_hmmss(). Otherwise, x-axis values are displayed as numeric.

n.breaks

A numeric value specifying the number of breaks in both x- and y-axes. Default is 5.

na.omit

Logical. Default is FALSE. If TRUE omits missing (NA) and non-finite c(Inf, -Inf, NaN) from display.

...

Additional arguments.

Value

A ggplot2 object.

Details

When x is a named list of "mnirs" data frames, elements are bound into a single data frame and displayed as faceted panels via ggplot2::facet_wrap().

Arguments in ... are currently passed to ggplot2::facet_wrap() formals, such as nrow, ncol, and scales for more precise control.

Examples

data <- read_mnirs(
    example_mnirs("train.red"),
    nirs_channels = c(smo2 = "SmO2"),
    time_channel = c(time = "Timestamp (seconds passed)"),
    verbose = FALSE
)

## plot time labels as "hh:mm:ss"
plot(data, time_labels = TRUE)


data_list <- extract_intervals(
    data,
    start = by_time(2452, 3168),
    span = c(-60, 120),
    verbose = FALSE
)

## plot a list of mnirs data frames as faceted panels
plot(data_list, time_labels = TRUE)