JuliaDynamics/RecurrenceAnalysis.jl

Improve help text/ documentation

Aberta

#115 aberto em 13 de abr. de 2021

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

Métricas do repositório

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

Description

Hi,

I have again the request to improve the documentation for some functions. In particular, it would be very helpful to have examples of several use cases in the documentation string.

For example, when calculating the recurrence matrix from a given 2-column vector (w/o embedding), it would be first necessary to create a DataSet type variable using tr = Dataset(x);. What about including such example:

x = rand(100,1)
tr = Dataset(x);
R = RecurrenceMatrix(tr, 0.1, fixedrate=true)

and similar for embedding

x = sin.(0:.01:12)
tr = embed(x, 2, 177);
R = RecurrenceMatrix(tr, 0.1, fixedrate=true)

Thanks! Norbert

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Guia do colaborador

Direção de pesquisa
Adicione os trechos de código exemplo às docstrings das funções relevantes (por exemplo, RecurrenceMatrix, embed) e certifique se de que eles compilam corretamente.
Pilha de tecnologia
julia
Domain
data
Tipo Issue
Documentaçã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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
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.
85