plot.Rd 2.29 KB
Newer Older
unknown's avatar
unknown committed
1
\encoding{UTF-8}
2
3
\name{plot}
\alias{plot}
4
\alias{plot.PrepGR}
5
6
\alias{plot.CalGR}
\alias{plot.SimGR}
7
8


9
\title{Time series plotting GR observation objects}
unknown's avatar
unknown committed
10
11


12
13
14
\description{Time series plotting GR observation objects}


unknown's avatar
unknown committed
15
\usage{
16
17
18
19
20
21
22
23
24
25
\method{plot}{PrepGR}(x, type = "l",
     col.Precip = "royalblue", col.Q = "black", col.na = "grey",
     xlab = NULL, ylab = NULL, main = NULL,
     plot.na = TRUE, ...)
  
\method{plot}{CalGR}(x, xlab = NULL, ylab = NULL, main = NULL,
     which = c("perf", "iter", "ts"), ...)

\method{plot}{SimGR}(x, ...)
  
unknown's avatar
unknown committed
26
27
28
29
}


\arguments{
30
  \item{x}{[object of class \emph{PrepGR}] see \code{\link{PrepGR}} for details}
unknown's avatar
unknown committed
31
  
32
  \item{type}{[character] the type of plot that should be drawn (see \code{\link[base]{plot}} for details)}
unknown's avatar
unknown committed
33
  
34
  \item{col.Precip}{(optional) [character]color code or name for precipitation, see \code{\link[graphics]{par}}}
unknown's avatar
unknown committed
35
  
36
  \item{col.Q}{(optional) [character] color code or name for observed flow, see \code{\link[graphics]{par}}}
unknown's avatar
unknown committed
37
  
38
  \item{col.na}{(optional) [character] color code or name for missing values, see \code{\link[graphics]{par}}}
unknown's avatar
unknown committed
39
  
40
  \item{xlab}{(optional) [character] a label for the x-axis (see \code{\link[graphics]{title}})}
unknown's avatar
unknown committed
41
  
42
  \item{ylab}{(optional) [character] a label for the y-axis (vector of 1 or 2 values for rainfall and flow respectively; see \code{\link[graphics]{title}})}
unknown's avatar
unknown committed
43
  
44
  \item{main}{(optional) [character] a main title for the plot (see \code{\link[graphics]{title}})}
unknown's avatar
unknown committed
45
  
46
  \item{plot.na}{[boolean] boolean indicating if the missing values are plotted on the x-axis}
unknown's avatar
unknown committed
47
  
unknown's avatar
unknown committed
48
  \item{...}{other parameters to be passed through to plotting functions}
49
50
51

  
  \item{which}{[character] choice of the plot type (\code{"perf"} (default): plot diagnostics; \code{"iter"}: parameter and calibration criterion values during the iterations of the steepest descent step of the airGR calibration algorithm; \code{"ts"}: time series of observed precipitation and observed and simulated flows)}
unknown's avatar
unknown committed
52
53
54
55
}


\seealso{
56
\code{\link{PrepGR}}
unknown's avatar
unknown committed
57
58
59
60
61
62
}


\author{Olivier Delaigue}

\examples{
63
library(airGRteaching)
unknown's avatar
unknown committed
64
65

## data.frame of observed data
66
data(L0123001, package = "airGR")
unknown's avatar
unknown committed
67
68
69
BasinObs2 <- BasinObs[, c("DatesR", "P", "E", "Qmm", "T")]

## Preparation of observed data for modelling
70
PREP <- PrepGR(ObsDF = BasinObs2, HydroModel = "GR4J", CemaNeige = FALSE)
unknown's avatar
unknown committed
71
72

## Observed data plotting
73
plot(PREP)
unknown's avatar
unknown committed
74
75
}