Plot_ReturnIntervals: Plot return intervals determined based on the Trend And Peaks...

View source: R/Plot_ReturnIntervals.R

Plot_ReturnIntervalsR Documentation

Plot return intervals determined based on the Trend And Peaks AnalysiS (tapas).

Description

Requires output from one of the following functions: global_thresh(), local_thresh(), or peak_detection().

Usage

Plot_ReturnIntervals(
  series = NULL,
  x.lim = NULL,
  y_lim = NULL,
  plot.x = F,
  plot.neg = F
)

Arguments

series

The output of global_thresh(), local_thresh(), or peak_detection().

x.lim

Limit age for the x-axis scale (time scale)

y_lim

A vector defining the limits of the y-axis scale.

plot.x

Boolean. If FALSE (by default), The x-axis labels are omitted.

plot.neg

Boolean. If TRUE (by default), the return intervals for both positive and negative anomalies are plotted.


wfinsinger/tapas documentation built on Aug. 22, 2024, 4:28 a.m.