ERPlot: Extreme rank plot

View source: R/All.R

ERPlotR Documentation

Extreme rank plot

Description

A plot to inspect the distribution of ordered data

Usage

ERPlot(
  x,
  Title = "Extreme Rank Plot",
  dist = "GenLog",
  pars = NULL,
  GF = NULL,
  ylabel = "Discharge (m3/s)",
  ln = FALSE
)

Arguments

x

numeric vector. A sample for inspection

Title

a character string to change the default title, which is "Extreme Rank Plot"

dist

a choice of distribution. The choices are "GenLog", "GEV", "Gumbel" and "GenPareto"

pars

a vector of length three. In the order of location, scale, & shape. If left null the parameters are estimated from x

GF

a vector of length three, in the order of; Lcv, LSkew and Median

ylabel

a character string. For user choice of a label for the y axis.

ln

logical TRUE or FALSE with a default of FALSE. If TRUE, the variable under consideration is log transformed for the plot

Details

By default the parameters of the distribution for comparison with the sample are estimated from the sample. However, the pars argument can be used to compare the distribution with parameters estimated separately. Similarly the growth factor (GF) parameters, linear coefficient of variation (Lcv) & linear skewness (LSkew) with the median can be entered. In this way the pooling estimated distribution can be compared to the sample. The ERplot is described in Hammond, A. (2019). Proposal of the ‘extreme rank plot’ for extreme value analysis: with an emphasis on flood frequency studies. Hydrology Research, 50 (6), 1495–1507.

Value

The extreme rank plot with GoTF scores

Author(s)

Anthony Hammond

Examples

#Get an AMAX sample and plot
AM.27083 <- GetAM(27083)
ERPlot(AM.27083$Flow)
#Get some pooled estimate of Lcv & LSkew to use with the GF argument
QuickResults(GetCDs(27083), gauged = TRUE)
#Use the resulting Lcv, Lskew and RP2 for the GF argument and change the title
ERPlot(AM.27083$Flow, Title = "Site 27083 pooled comparison", GF = c(0.2286109, 0.1536903, 12.513))

UKFE documentation built on Nov. 6, 2023, 1:07 a.m.

Related to ERPlot in UKFE...