JuliaDynamics/RecurrenceAnalysis.jl

Improve help text/ documentation

開放

#115 建立於 2021年4月13日

 (2 則留言) (0 個反應) (0 位負責人)Julia (16 個分叉)auto 404
documentationgood first issue

倉庫指標

星標
 (50 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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.

貢獻者指南