Get (C)RQA measures based on a binary matrix

A zoo of measures based on singular recurrent points, diagonal, vertical and horizontal line structures (anisotropic) will be caluclated.

Usage

rp_measures(
  RM,
  emRad = NA,
  DLmin = 2,
  VLmin = 2,
  HLmin = 2,
  DLmax = length(Matrix::diag(RM)),
  VLmax = length(Matrix::diag(RM)),
  HLmax = length(Matrix::diag(RM)),
  AUTO = NULL,
  theiler = NA,
  chromatic = NA,
  anisotropyHV = FALSE,
  asymmetryUL = FALSE,
  returnUL = FALSE,
  recurrenceTimes = FALSE,
  matrices = FALSE,
  Nboot = NULL,
  CL = 0.95,
  targetValue = 0.05,
  use_rqa_par = FALSE,
  silent = TRUE
)

Arguments

RM

A distance matrix (set emRad = NA to estimate a radius), or a matrix of zeroes and ones

emRad

Threshold for distance value that counts as a recurrence (ignored is RM is a binary matrix)

DLmin

Minimal diagonal line length (default = 2)

VLmin

Minimal vertical line length (default = 2)

HLmin

Minimal horizontal line length (default = 2)

DLmax

Maximal diagonal line length (default = length of diagonal -1)

VLmax

Maximal vertical line length (default = length of diagonal -1)

HLmax

Maximal horizontal line length (default = length of diagonal -1)

AUTO

Auto-recurrence? (default = FALSE)

theiler

Use a theiler window around the main diagonal (Line of Identity/Synchronisation) to remove auto-correlations at short time-lags:

0 will include the main diagonal in all RQA measure calculations.
1 will remove the main diagonal from all RQA measure calculations.
NA (default), will check if the matrix is symmetrical , if so, it will remove the diagonal by setting theiler = 1 (Line of Identity, Auto-RQA), if it is not symmetrical (Line of Synchronisation, Cross-RQA) it will set theiler = 0.
A value greater than 1 will remove that many diagonals around and including the diagonal from all RQA measure calculations. So theiler = 2 means exclude 2 diagonals around the main diagonal, including the main diagonal itself: [-1,0,1]. If theiler is a numeric vector of length(theiler) == 2 it is possible to exclude an asymmetrical window. The values are interpreted as end points in a sequence of diagonal ID's, e.g. theiler = c(-1,5) will exclude [-1,0,1,2,3,4,5]. If length(theiler) > 2, the values will be considered individual diagonal ID's, e.g. theiler = c(-3,-1,0,2,5), will exclude only those specific ID's. Also see the note.

chromatic

Force chromatic RQA? If NA the value of the RM attribute "chromatic" will be used, if present (default = NA)

anisotropyHV

Return anisotropy ratio measures based on Horizontal and Vertical lines. The ratios are calculated as (horizontal - vertical) / (horizontal + vertical). So a value of 0 means no anisotropy, negative ratios indicate the measures based on vertical lines had higher values, positive ratios indicate the measures based on horizontal lines had higher values (default = FALSE)

asymmetryUL

Return asymmetry ratio measures based on Upper and Lower triangles. The ratios are calculated as (upper - lower) / (upper + lower). So a value of 0 means no asymmetry, negative ratios indicate the measures based on the lower triangle had the higher values, positive ratios indicate measures based on the upper triangle had higher values (default = FALSE)

returnUL

Return the (C)RQA values for the upper and lower triangle on which asymmetry ratio calculations are based? (default = FALSE)

recurrenceTimes

Return measures based on 'white lines', the recurrence times (default = FALSE)

matrices

Return matrices? (default = FALSE)

Nboot

How many bootstrap replications? (default = NULL)

CL

Confidence limit for bootstrap results (default = .95)

targetValue

A value passed to est_radius(...,type="fixed", targetMeasure="RR", tol = .2) if is.na(emRad)==TRUE, it will estimate a radius (default = .05).

use_rqa_par

Use function rqa_par() if matrix dims > (default = FALSE)

silent

Do not display any messages (default = TRUE)

Value

A list object containing (C)RQA measures (and matrices if requested)

Get (C)RQA measures based on a binary matrix

Usage

Arguments

Value

See also