genRmExample: A function to generate a recurrence matrix example

In KarsTS: An Interface for Microclimate Time Series Analysis

Description

A function to generate a recurrence matrix example. It can be assigned to the KTSEnv environment.

Usage

genRmExample(name = "SRM", InKTSEnv = TRUE, plotRM = FALSE)

Arguments

name	A name for the recurrence matrix. When the local environment is used instead of KTSEnv, the name is still necessary for the recurrence plot title.
InKTSEnv	Assign the output to the KTSEnv (TRUE) or to the local environment (FALSE)
plotRM	Plot the recurrence matrix (TRUE) or not (FALSE)

Details

The recurrence matrix is calculated on a sinusoidal time series composed with a random walk. The embedding dimension is 2, the delay is 290 and the threshold is 20.

Value

The recurrence matrix and the time series

Author(s)

Marina Saez Andreu

Examples

 res <- genRmExample(name = "RMExample", InKTSEnv = FALSE, plotRM = FALSE)
 res$newSimpRM
 res$TS

KarsTS documentation built on Jan. 16, 2021, 5:07 p.m.