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.

贡献者指南