JuliaDynamics/RecurrenceAnalysis.jl

Source code clarity of `recurrence_matrix`

Open

#136 opened on May 22, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Julia (16 forks)auto 404
claritygood first issue

Repository metrics

Stars
 (50 stars)
PR merge metrics
 (PR metrics pending)

Description

At the moment the source code of recurrence_matrix, which is where the central computations of a recurrence matrix take place, is full of duplication. There version complexity scales as 2 x 2 x 2 = 8, with a multiplicity of 2 for (recurrences vs cross-recurence), (parallel vs non parallel), (dataset vs vector).

I do not believe that having 8 different methods is necessary. In fact, it may even be that we could do everything with 1 or 2 methods, by defining smaller helper functions.

In any case, a multiplicity of 8 is certainly not necessary and the source code can be simplified to remove duplication and thus make long term maintanance also easier.

Contributor guide

Research direction
Analyze the 8 existing methods for recurrence matrix, identify common patterns and parameters, and design helper functions to reduce duplication. Start by reading the source code and understanding the differences between the variants.
Tech stack
julia
Domain
data
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60