JuliaDynamics/RecurrenceAnalysis.jl

Source code clarity of `recurrence_matrix`

Ouverte

#136 ouverte le 22 mai 2022

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Julia (16 forks)auto 404
claritygood first issue

Métriques du dépôt

Stars
 (50 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Analysez les 8 méthodes existantes pour recurrence matrix, identifiez les modèles et paramètres communs, et concevez des fonctions d'aide pour réduire la duplication. Commencez par lire le code source et comprendre les différences entre les variantes.
Stack technique
julia
Domaine
data
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60