JuliaDynamics / JuliaDynamics/RecurrenceAnalysis.jl

Add ComplexityMeasures.jl interface support

Open
#181 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
50
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Describe the feature you'd like to have

Recently in RecurrenceMicrostatesAnalysis we have added full support for the ComplexityMeasures.jl API; this came with a lot advantages, in particular (1) formalizing obtaining and analyzing the probabilities corresponding to various microstates, and (2) making it clear and explicity how all the various recurrence microstate analysis metrics are complexity measures.

We should do the same here! We have methods that return histograms for diagonal or vertical lines, and this is what an extension of the probabilitiesAPI can provide.

Cite scientific papers related to the feature/algorithm

To my knowledge there aren't any papers that present RQA as complexity measures in the way of ComplexityMeasures.jl as functionals of probability mass functions or not.

If possible, sketch out an implementation strategy

Thankfully that's very easy, follow the tutorial of RecurrenceMicrostatesAnalysis.jl: https://juliadynamics.github.io/DynamicalSystemsDocs.jl/recurrencemicrostatesanalysis/stable/


The old RQA API will all stay exactly as is of course and still be available as the RQA community is very large and don't have to relate RQA with complexity measures.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the RecurrenceMicrostatesAnalysis.jl tutorial linked in the issue, then inspect the existing diagonal- and vertical-line histogram methods in RecurrenceAnalysis.jl. The work is done when a ComplexityMeasures.jl-compatible probabilities interface is available while the existing RQA API remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.