plot.gmwm: Plot the GMWM with the Wavelet Variance

View source: R/gmwm.r

plot.gmwmR Documentation

Plot the GMWM with the Wavelet Variance

Description

Displays a plot of the Wavelet Variance (WV) with the CI values and the WV implied by the estimated parameters.

Usage

## S3 method for class 'gmwm'
plot(
  x,
  decomp = FALSE,
  units = NULL,
  xlab = NULL,
  ylab = NULL,
  main = NULL,
  col_wv = NULL,
  col_ci = NULL,
  nb_ticks_x = NULL,
  nb_ticks_y = NULL,
  legend_position = NULL,
  ci_wv = NULL,
  point_cex = NULL,
  point_pch = NULL,
  ...
)

Arguments

x

A gmwm object.

decomp

A boolean that determines whether the contributions of each individual model are plotted.

units

A string that specifies the units of time plotted on the x axis.

xlab

A string that gives a title for the x axis.

ylab

A string that gives a title for the y axis.

main

A string that gives an overall title for the plot.

col_wv

A string that specifies the color of the wavelet variance line.

col_ci

A string that specifies the color of the shaded area covered by the confidence intervals.

nb_ticks_x

An integer that specifies the maximum number of ticks for the x-axis.

nb_ticks_y

An integer that specifies the maximum number of ticks for the y-axis.

legend_position

A string that specifies the position of the legend (use legend_position = NA to remove legend).

ci_wv

A boolean that determines whether to plot the confidence interval shaded area.

point_cex

A double that specifies the size of each symbol to be plotted.

point_pch

A double that specifies the symbol type to be plotted.

...

Additional arguments affecting the plot.

Value

Plot of WV and relative confidence intervals for each scale.

Author(s)

Stephane Guerrier and Yuming Zhang


SMAC-Group/simts documentation built on Sept. 4, 2023, 5:25 a.m.