Convenience wrapper for pr_plot_heatmap() that always overlays
region boundaries.
Usage
pr_plot_heatmap_masked(
trial,
masks = NULL,
frame = NULL,
type = c("mpp", "mvp", "pti", "contact"),
palette = "viridis",
range = NULL,
title = NULL
)Arguments
- trial
A pr_trial object.
- masks
Named list of pr_mask objects or logical matrices. If
NULL, uses layout regions.- frame
Integer. Frame number to display. If
NULL(default), shows the summary picture specified bytype.- type
Character. Summary type when
frameisNULL:"mpp"(max),"mvp"(mean),"pti"(pressure-time integral),"contact"(contact frequency).- palette
Character. One of
"viridis"(default),"inferno","plasma","magma","jet","classic".- range
Numeric vector of length 2. Colour range.
NULLauto-scales.- title
Character. Plot title.
NULLauto-generates.
Examples
pr_plot_heatmap_masked(pr_example_trial("saddle_horse"))