visualize_vtrapz: Visualize 'vtrapz()' and 'cumvtrapz()'

In groupedHyperframe: Grouped Hyper Data Frame

Visualize vtrapz() and cumvtrapz()

Description

Visualize (cumulative) average vertical height of trapezoidal integration.

Usage

visualize_vtrapz(
  x,
  y,
  x_smooth,
  y_smooth,
  xlabs,
  ylabs,
  yname,
  draw.rect,
  draw.v,
  label.v,
  draw.cumv,
  label.cumv,
  ...
)

## S3 method for class 'numeric'
visualize_vtrapz(
  x,
  y,
  x_smooth = x,
  y_smooth = y,
  xlabs,
  ylabs,
  yname,
  draw.rect = TRUE,
  draw.v = draw.rect,
  label.v = "Average Vertical Height",
  draw.cumv = TRUE,
  label.cumv = "Cumulative Average Vertical Height",
  ...
)

## S3 method for class 'fv'
visualize_vtrapz(x, ...)

## S3 method for class 'listof'
visualize_vtrapz(x, ...)

## S3 method for class 'density'
visualize_vtrapz(x, ...)

## S3 method for class 'stepfun'
visualize_vtrapz(x, ...)

## S3 method for class ''function''
visualize_vtrapz(x, ..., n = 513L)

## S3 method for class 'loess'
visualize_vtrapz(x, ..., n = 513L)

## S3 method for class 'smooth.spline'
visualize_vtrapz(x, ..., n = 513L)

## S3 method for class 'ksmooth'
visualize_vtrapz(x, ...)

## S3 method for class 'spline'
visualize_vtrapz(x, ..., n = 513L)

## S3 method for class 'xyVector'
visualize_vtrapz(x, ...)

Arguments

x	see Usage
y	numeric vector
x_smooth, y_smooth	numeric vectors, smoothed x and y values, to beautify the geom_textpath of a stepfun
xlabs, ylabs	functions
yname	(optional) character scalar, name of the function
draw.rect	logical scalar, whether to plot the rectangle, default TRUE
draw.v	logical scalar, whether to plot the average vertical height vtrapz(), default is determined by parameter draw.rect.
label.v, label.cumv	character scalars
draw.cumv	logical scalar, whether to plot the cumulative average vertical height cumvtrapz(), default TRUE
...	additional parameters, currently of no use
n	integer, number of (x,y)-values at which to evaluate, only applicable when the input inherits from the S3 class function, or has an S3 method of ⁠predict.*()⁠ available.

Value

The S3 generic function visualize_vtrapz() returns a ggplot object.

groupedHyperframe documentation built on March 10, 2026, 5:08 p.m.