x3p_mask_quantile {x3ptools}

Draw a quantile region on the mask

Description

For each x value of the surface matrix add a region to the mask of an x3p object corresponding to the area between two specified quantiles.

Usage

x3p_mask_quantile(
  x3p,
  quantiles = c(0.25, 0.75),
  color = "red",
  annotation = "quantile-region"
)

Arguments

x3p

x3p object

quantiles

vector of quantiles between which surface matrix values are included in the mask

color

name or hex value of color

annotation

character value describing the region

Value

x3p object with changed mask