JuliaDynamics/RecurrenceAnalysis.jl

Improve help text/ documentation

Ouverte

#115 ouverte le 13 avr. 2021

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

Métriques du dépôt

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

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.

Guide contributeur

Direction de recherche
Ajoutez les extraits de code d'exemple aux docstrings des fonctions pertinentes (par exemple RecurrenceMatrix, embed) et assurez vous qu'ils se compilent correctement.
Stack technique
julia
Domaine
data
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
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.
85