JuliaDynamics/RecurrenceAnalysis.jl

Improve help text/ documentation

Open

#115 opened on Apr 13, 2021

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

Repository metrics

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

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.

Contributor guide

Research direction
Add the example code snippets to the docstrings of the relevant functions (e.g., RecurrenceMatrix, embed) and ensure they compile correctly.
Tech stack
julia
Domain
data
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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.
85