areaVolumeHysteresisPlot: Plots area-volume hysteresis curves of total water area...

In KevinShook/WDPMr: Post-processing for the WDPM and PCM models

Plots area-volume hysteresis curves of total water area against volume

Description

Plots area-volume hysteresis curves of total water area against volume

Usage

areaVolumeHysteresisPlot(
  curve1,
  curve2,
  extend = TRUE,
  normalize = TRUE,
  outfile = "",
  N = 1
)

Arguments

curve1	Required. Data frame containing the filling curve.
curve2	Required. Data frame containing the emptying curve.
extend	Optional. Should curves extend to origin? Default is TRUE.
normalize	Optional. Should areas and volumes be divided by their maximum values? Default is TRUE.
outfile	Optional. File name for output of line segments. If not specified (the default), the data are not ouput.
N	Optional. Plot arrows every Nth point. Default is 1.

Value

Returns a ggplot2 object of the area vs volume. The line segments are written to a file (if specified).

Examples

## Not run: 
p <- areaVolumeHysteresisPlot(curve1, curve2)
## End(Not run)

KevinShook/WDPMr documentation built on April 23, 2022, 12:32 a.m.