JuliaDynamics/RecurrenceAnalysis.jl

Improve help text/ documentation

オープン

#115 opened on 2021/04/13

 (2 件のコメント) (0 件のリアクション) (0 人の担当者)Julia (16 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (50 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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.

コントリビューターガイド