The R Project SVN R

Rev

Rev 27497 | Rev 56184 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 27497 Rev 35065
Line 6... Line 6...
6
\description{
6
\description{
7
  Plotting method for objects of class \code{"spec"}.  For multivariate
7
  Plotting method for objects of class \code{"spec"}.  For multivariate
8
  time series it plots the marginal spectra of the series or pairs plots
8
  time series it plots the marginal spectra of the series or pairs plots
9
  of the coherency and phase of the cross-spectra.
9
  of the coherency and phase of the cross-spectra.
10
}
10
}
11
\synopsis{
-
 
12
plot.spec(x, add = FALSE, ci = 0.95, log = c("yes", "dB", "no"), 
-
 
13
    xlab = "frequency", ylab = NULL, type = "l",
-
 
14
    ci.col = "blue", main = NULL, sub = NULL,
-
 
15
    plot.type = c("marginal", "coherency", "phase"), \dots) 
-
 
16
plot.spec.phase(x, ci = 0.95, xlab = "frequency",
-
 
17
    ylab = "phase", ylim = c(-pi, pi), type = "l",
-
 
18
    main = NULL, ci.lty = 3, ci.col = "blue", \dots) 
-
 
19
plot.spec.coherency(x, ci = 0.95, xlab = "frequency",
-
 
20
    ylab = "squared coherency", ylim = c(0, 1), type = "l",
-
 
21
    main = NULL, ci.lty = 3, ci.col = "blue", \dots)
-
 
22
}
-
 
23
\usage{
11
\usage{
24
\method{plot}{spec}(x, add = FALSE, ci = 0.95, log = c("yes", "dB", "no"),
12
\method{plot}{spec}(x, add = FALSE, ci = 0.95, log = c("yes", "dB", "no"),
25
     xlab = "frequency", ylab, type = "l", ci.col = "blue",
13
     xlab = "frequency", ylab = NULL, type = "l",
-
 
14
     ci.col = "blue", ci.lty = 3, 
26
     main = NULL, sub = NULL,
15
     main = NULL, sub = NULL,
27
     plot.type = c("marginal", "coherency", "phase"),
16
     plot.type = c("marginal", "coherency", "phase"),
28
     ci.lty = 3, \dots)
17
     \dots)
-
 
18
 
-
 
19
plot.spec.phase(x, ci = 0.95,
-
 
20
                xlab = "frequency", ylab = "phase",
-
 
21
                ylim = c(-pi, pi), type = "l",
-
 
22
                main = NULL, ci.col = "blue", ci.lty = 3, \dots) 
-
 
23
 
-
 
24
plot.spec.coherency(x, ci = 0.95,
-
 
25
                    xlab = "frequency",
-
 
26
                    ylab = "squared coherency",
-
 
27
                    ylim = c(0, 1), type = "l",
-
 
28
                    main = NULL, ci.col = "blue", ci.lty = 3, \dots)
29
}
29
}
30
\arguments{
30
\arguments{
31
  \item{x}{an object of class \code{"spec"}.}
31
  \item{x}{an object of class \code{"spec"}.}
32
  \item{add}{logical.  If \code{TRUE}, add to already existing plot.}
32
  \item{add}{logical.  If \code{TRUE}, add to already existing plot.
-
 
33
    Only valid for \code{plot.type = "marginal"}.
-
 
34
  }
33
  \item{ci}{Coverage probability for confidence interval.  Plotting of
35
  \item{ci}{coverage probability for confidence interval.  Plotting of
34
    the confidence bar is omitted unless \code{ci} is strictly
36
    the confidence bar/limits is omitted unless \code{ci} is strictly
35
    positive.}
37
    positive.}
36
  \item{log}{If \code{"dB"}, plot on log10 (decibel) scale (as S-PLUS),
38
  \item{log}{If \code{"dB"}, plot on log10 (decibel) scale (as S-PLUS),
37
    otherwise use conventional log scale or linear scale.  Logical
39
    otherwise use conventional log scale or linear scale.  Logical
38
    values are also accepted.  The default is \code{"yes"} unless
40
    values are also accepted.  The default is \code{"yes"} unless
39
    \code{options(ts.S.compat = TRUE)} has been set, when it is
41
    \code{options(ts.S.compat = TRUE)} has been set, when it is
40
    \code{"dB"}.}
42
    \code{"dB"}.  Only valid for \code{plot.type = "marginal"}.
-
 
43
  }
41
  \item{xlab}{the x label of the plot.}  
44
  \item{xlab}{the x label of the plot.}  
42
  \item{ylab}{the y label of the plot.}
45
  \item{ylab}{the y label of the plot.  If missing a suitable label will
-
 
46
    be constructed.}
43
  \item{type}{the type of plot to be drawn, defaults to lines.}
47
  \item{type}{the type of plot to be drawn, defaults to lines.}
44
  \item{ci.col}{Colour for plotting confidence bar or confidence
48
  \item{ci.col}{colour for plotting confidence bar or confidence
45
    intervals for coherency and phase.}
49
    intervals for coherency and phase.}
46
  \item{main}{overall title for the plot.}
-
 
47
  \item{sub}{a sub title for the plot.}
-
 
48
  \item{plot.type}{For multivariate time series, the type of plot
-
 
49
    required.  Only the first character is needed.}
-
 
50
  \item{ci.lty}{line type for confidence intervals for coherency and
50
  \item{ci.lty}{line type for confidence intervals for coherency and
51
    phase.}
51
    phase.}
-
 
52
  \item{main}{overall title for the plot. If missing, a suitable title
-
 
53
    is constructed.}
-
 
54
  \item{sub}{a sub title for the plot.  Only used for \code{plot.type =
-
 
55
      "marginal"}.  If missing, a description of the smoothing is used.}
-
 
56
  \item{plot.type}{For multivariate time series, the type of plot
-
 
57
    required.  Only the first character is needed.}
52
  \item{\dots}{Further graphical parameters.}
58
  \item{ylim, \dots}{Graphical parameters.}
53
}
59
}
54
\seealso{
60
\seealso{
55
  \code{\link{spectrum}}
61
  \code{\link{spectrum}}
56
}
62
}
57
\keyword{hplot}
63
\keyword{hplot}