JuliaDynamics / JuliaDynamics/RecurrenceAnalysis.jl
Improve help text/ documentation
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 50
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation strings for Dataset, embed, and RecurrenceMatrix. Add examples covering recurrence matrices with and without embedding, using the cases shown in the issue; done means the examples appear in the relevant help text and are valid Julia usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100