IDF.plot.Rd 1.79 KB
Newer Older
Christoph Ritschel's avatar
Christoph Ritschel committed
1
% Generated by roxygen2: do not edit by hand
Rust Henning's avatar
Rust Henning committed
2
3
4
% Please edit documentation in R/IDF.R
\name{IDF.plot}
\alias{IDF.plot}
5
\title{Plotting of IDF curves at a chosen station}
Rust Henning's avatar
Rust Henning committed
6
\usage{
7
8
9
IDF.plot(data, fitparams, probs = c(0.5, 0.9, 0.99), calc.dur = NULL,
  cols = 4:2, add = FALSE, ylim = NULL, xlim = NULL,
  legend = TRUE, st.name = "Station", dt.name = "observations", ...)
Rust Henning's avatar
Rust Henning committed
10
11
}
\arguments{
12
13
\item{data}{matrix or dataframe containing: first column maxima,
second column coresponding durations}
Rust Henning's avatar
Rust Henning committed
14

15
16
17
\item{fitparams}{vector containing parameters mut, sigma0, xi, theta, eta
(modified location, scale, shape, duration offset, duration exponent) for chosen station
as obtained from \code{\link{gev.d.fit}}.}
Rust Henning's avatar
Rust Henning committed
18

19
\item{probs}{vector of exeedance probabilities for which to plot IDF curves (p = 1-1/ReturnPeriod)}
Rust Henning's avatar
Rust Henning committed
20

21
22
\item{calc.dur}{vector of durations for which to calculate IDF curves. If `NULL` (the default),
durations from data are taken}
Rust Henning's avatar
Rust Henning committed
23

24
\item{cols}{vector of colors for IDF curves. Should have same length as \code{probs}}
Christoph Ritschel's avatar
Christoph Ritschel committed
25

26
\item{add}{logical indicating if plot should be added to existing plot}
Rust Henning's avatar
Rust Henning committed
27

28
\item{xlim, ylim}{vectors of x- / y-plot-range}
Rust Henning's avatar
Rust Henning committed
29

30
31
32
33
34
35
36
\item{legend}{logical indicating if legend should be plotted}

\item{st.name}{string containing legend title (for example station name)}

\item{dt.name}{string containing name for data points in legend}

\item{...}{additional parameters passed on to the \code{plot} function}
Rust Henning's avatar
Rust Henning committed
37
38
}
\description{
39
Plotting of IDF curves at a chosen station
Rust Henning's avatar
Rust Henning committed
40
}
Christoph Ritschel's avatar
Christoph Ritschel committed
41
\examples{
42
43
44
data('example',package = 'IDF')
fit <- gev.d.fit(example$dat,example$d,ydat = as.matrix(example[,c("cov1","cov2")])
                 ,mul = c(1,2),sigl = 1)
Jana Ulrich's avatar
Jana Ulrich committed
45
par <- gev.d.params(fit = fit, ydat = cbind(1,1))
46
47
IDF.plot(data = example[example$cov1==1,c("dat","d")],fitparams = unlist(par),
         calc.dur = 2^(0:5),ylim=c(1,75),st.name = 'Example')
Christoph Ritschel's avatar
Christoph Ritschel committed
48
}