Improve help text/ documentation

[pucicu]

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!](https://www.bountysource.com/issues/98267553-improve-help-text-documentation?utm_campaign=plugin&utm_content=tracker%2F28405688&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F28405688&utm_medium=issues&utm_source=github).

[Datseris]

Hi,

sure, but where do you think this example should be? In the docstring of RecurrenceMatrix?

[pucicu]

It should appear when calling the help from the REPL (calling ?RecurrenceMatrix) and also in the Example section at https://juliadynamics.github.io/DynamicalSystems.jl/latest/rqa/rplots/#RecurrenceAnalysis.RecurrenceMatrix  https://juliadynamics.github.io/DynamicalSystems.jl/latest/rqa/rplots/#RecurrenceAnalysis.RecurrenceMatrix

Am 13.04.2021 um 12:09 schrieb George Datseris @.***>:

Hi,

sure, but where do you think this example should be?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/JuliaDynamics/RecurrenceAnalysis.jl/issues/115#issuecomment-818618625, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHNNEEGJ25MGYXNAU2BOOLTIQJ4DANCNFSM423AWWOA.