JuliaDynamics/RecurrenceAnalysis.jl

Source code clarity of `recurrence_matrix`

Aberta

#136 aberto em 22 de mai. de 2022

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Julia (16 forks)auto 404
claritygood first issue

Métricas do repositório

Stars
 (50 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Analise os 8 métodos existentes para recurrence matrix, identifique padrões e parâmetros comuns e projete funções auxiliares para reduzir a duplicação. Comece lendo o código fonte e entendendo as diferenças entre as variantes.
Pilha de tecnologia
julia
Domain
data
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Julia
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60