plot.vectorwavelet: Plot 'vectorwavelet' objects

In vectorwavelet: Vector Wavelet Coherence for Multiple Time Series

Description

Plot vectorwavelet objects which are multiple wavelet coherence, quadruple wavelet coherence and n-dimensional vector wavelet coherence.

Usage

## S3 method for class 'vectorwavelet'
plot(
  x,
  ncol = 1024,
  fill.cols = NULL,
  xlab = "Time",
  ylab = "Period",
  tol = 1,
  plot.cb = FALSE,
  plot.coi = TRUE,
  lwd.coi = 1,
  col.coi = "white",
  lty.coi = 1,
  alpha.coi = 0.5,
  plot.sig = TRUE,
  lwd.sig = 4,
  col.sig = "black",
  lty.sig = 1,
  bw = FALSE,
  legend.loc = NULL,
  legend.horiz = FALSE,
  arrow.len = min(par()$pin[2]/30, par()$pin[1]/40),
  arrow.lwd = arrow.len * 0.3,
  arrow.cutoff = 0.7,
  arrow.col = "black",
  xlim = NULL,
  ylim = NULL,
  zlim = c(0, 1),
  xaxt = "s",
  yaxt = "s",
  form = "%Y",
  ...
)

Arguments

x	vectorwavelet object generated by mwc, qmec, or vwc.
ncol	number of colors to use. Default is 1024.
fill.cols	Vector of fill colors to be used. Users can specify color vectors using colorRampPalette or brewer.pal from package RColorBrewer. Default is NULL and will generate MATLAB's jet color palette.
xlab	xlabel of the figure. Default is "Time"
ylab	ylabel of the figure. Default is "Period"
tol	tolerance level for significance contours. Sigificance contours will be drawn around all regions of the spectrum where spectrum/percentile >= tol. Default is 1. If strict i^{th} percentile regions are desired, then tol must be set to 1.
plot.cb	plot color bar if TRUE. Default is FALSE.
plot.coi	plot cone of influence (COI) as a semi-transparent polygon if TRUE. Default is TRUE. Areas that fall within the polygon can be affected by edge effects.
lwd.coi	Line width of COI. Default is 1.
col.coi	Color of COI. Default is white.
lty.coi	Line type of COI. Default is 1 for solide lines.
alpha.coi	Transparency of COI. Range is 0 (full transparency) to 1 (no transparency). Default is 0.5.
plot.sig	plot contours for significance if TRUE. Default is TRUE.
lwd.sig	Line width of significance contours. Default is 4.
col.sig	Color of significance contours. Default is black.
lty.sig	Line type of significance contours. Default is 1.
bw	plot in black and white if TRUE. Default is FALSE.
legend.loc	legend location coordinates as defined by image.plot. Default is NULL.
legend.horiz	plot a horizontal legend if TRUE. Default is FALSE.
arrow.len	size of the arrows. Default is based on plotting region (min(par()$pin[2]/30,par()$pin[1]/40).
arrow.lwd	width/thickness of arrows. Default is arrow.len*0.3.
arrow.cutoff	cutoff value for plotting phase arrows. Phase arrows will be be plotted in regions where the significance of the zvalues exceeds arrow.cutoff. If the object being plotted does not have a significance field, regions whose zvalues exceed the arrow.cutoff quantile will be plotted. Default is 0.7.
arrow.col	Color of arrows. Default is black.
xlim	the x limits. The default is NULL.
ylim	the y limits. The default is NULL.
zlim	the z limits. The default is NULL.
xaxt	Add x-axis? The default is s; use n for none.
yaxt	Add y-axis? The default is s; use n for none.
form	format to use to display dates on the x-axis. Default is '%Y' for 4-digit year. See ?Date for other valid formats.
...	other parameters.

Value

No return value, shows the objects plot.

Author(s)

Tunc Oygur ([e-mail])

Code based on biwavelet package written by Tarik C. Gouhier.

vectorwavelet documentation built on Jan. 16, 2021, 5:38 p.m.