plotLextreme: Plot extreme value statistics

View source: R/plotLextreme.R

plotLextremeR Documentation

Plot extreme value statistics

Description

Plots distributions fitted by L-moments and adds plotting positions by Weibull and Gringorton. This is an auxiliary graphing function to distLextreme

Usage

plotLextreme(
  dlf,
  selection = NULL,
  order = FALSE,
  add = FALSE,
  nbest = 5,
  log = "",
  xlim = NULL,
  ylim = NULL,
  las = 1,
  main = dlf$datname,
  xlab = "Return Period RP  [a]",
  ylab = "Discharge HQ  [m\U00B3/s]",
  PPcol = "black",
  PPpch = c(16, 3),
  PPcex = 1,
  distcols = berryFunctions::rainbow2(nbest),
  lty = 1,
  lwd = 1,
  pch = NA,
  cex = 1,
  n_pch = 15,
  legend = TRUE,
  rmse = 4,
  legargs = NULL,
  quiet = FALSE,
  logargs = NULL,
  ...
)

Arguments

dlf

List as returned by distLextreme or distLexBoot

selection

Selection of distributions. Character vector with type as in lmom2par. DEFAULT: NULL

order

If selection is given, should legend and colors be ordered by gof anyways? DEFAULT: FALSE

add

If TRUE, plot is not called before adding lines. This lets you add lines to an existing plot. DEFAULT: FALSE

nbest

Number of distributions plotted, in order of goodness of fit. Overwritten internally if selection is given. DEFAULT: 5

log

Charstring ("x", "y", "xy") for logarithmic axes. See logargs. DEFAULT: ""

xlim

X-axis limits. DEFAULT: xlim of plotting positions

ylim

Y-lim. DEFAULT: from min to extended max

las

LabelAxisStyle to orient labels, see par. DEFAULT: 1

main

Title of plot. DEFAULT: dlf$datname

xlab

X axis label. DEFAULT: "Return Period RP [a]"

ylab

Y axis label. Please note that the ubuntu pdf viewer might be unable to display unicode superscript. DEFAULT: "Discharge HQ [m3/s]"

PPcol

Plotting Position point colors, vector of length two for Weibull and Gringorton, recycled. PP are not used for fitting distributions, but for plotting only. DEFAULT: "black"

PPpch

point characters for plotting positions after Weibull and Gringorton, respectively. NA to suppress in plot and legend. DEFAULT: c(16,3)

PPcex

Character EXpansion of plotting points. DEFAULT: 1

distcols

Color for each distribution added with lines. Recycled, if necessary. DEFAULT: rainbow2

lty

Line TYpe for plotted distributions. Is recycled to from a vector of length nbest, i.e. a value for each dist. DEFAULT: 1

lwd

Line WiDth of distribution lines. Recycled vector of length nbest. DEFAULT: 1

pch

Point CHaracter of points added at regular intervals. This makes lines more distinguishable from each other. NA to suppress. Recycled vector of length nbest. DEFAULT: NA

cex

if pch != NA, size of points. Recycled vector of length nbest. DEFAULT: 1

n_pch

Number of points spread evenly along the line. Recycled vector of length nbest. DEFAULT: 15

legend

Logical. Add a legend? DEFAULT: TRUE

rmse

Integer. If rmse > 0, RMSE values are added to legend. They are rounded to rmse digits. DEFAULT: 4

legargs

list of arguments passed to legend except for legend, col, pch, lwd, lty. DEFAULT: NULL

quiet

Suppress notes? DEFAULT: FALSE

logargs

list of arguments passed to berryFunctions::logAxis.

...

Further arguments passed to plot like yaxt="n", ...

Value

invisible dlf object, see printL

Author(s)

Berry Boessenkool, berry-b@gmx.de, March 2015, updated heavily Aug 2015

See Also

distLextreme, plotLfit

Examples

#see
?distLextreme


brry/extremeStat documentation built on Nov. 24, 2022, 3:35 p.m.