KorcakPlot1: Korcak plot of 1 data set of water areas

View source: R/KorcakPlot1.R

KorcakPlot1R Documentation

Korcak plot of 1 data set of water areas

Description

Korcak plot of 1 data set of water areas

Usage

KorcakPlot1(
  areas,
  minval = 100,
  addLine = "none",
  lineColour = "red",
  useLargest = FALSE
)

Arguments

areas

Required. Vector of water areas.

minval

Optional. Minimum water area to be plotted. Default is 100 m2.

addLine

Optional. Default is none. Other options are linear, quadratic, gpd and pareto2.

lineColour

Optional. Colour to be used for the fitted line. Default is red.

useLargest

Optional. If TRUE then the largest value will be used, i.e. its non-exceedence probability willl be > 0. Default is FALSE.

Value

Returns ggplot2 object of Korcak plot.

Examples

## Not run: 
p <- KorcakPlot1(alldata$areas)
## End(Not run)

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