names of RQA functions

[heliosdrm]

After some discussion in #24 I propose the following changes in the names of the functions for RQA. It means deprecating three of the older names, and adding a couple of parameters that I have not actually seen reported in papers, like the entropy of vertical lines or the longest recurrence time. But the advantage is that the set of functions and their names follow a more systematic pattern, easier to remember. This is what pyunicorn and PyRQA also do, so it facilitates understanding for users of both Python and Julia.

(Each function name is accompanied by the key of the corresponding dictionary item returned by rqa in square brackets.)

These conventional names remain without changes:

• recurrencerate ["RR"]
• determinism ["DET"]
• divergence ["DIV"]
• laminarity ["LAM"]
• trappingtime ["TT"]
• trend ["TND"]

In addition, diagonal lines, vertical lines and recurrence times will have functions to calculate their mean and maximum value, and their (Shannon) entropy, with the following common pattern (this may be nicely meta-programmed):

For diagonal lines:

• dl_average ["L"] (deprecates avgdiag)
• dl_max ["Lmax"] (deprecates maxdiag)
• dl_entropy ["ENT"] (deprecates rqaentropy)

For vertical lines:

• vl_average (equivalent to trappingtime, which will remain)
• vl_max ["Vmax"] (deprecates maxdiag)
• vl_entropy ["VENT"]

For recurrence times (all new)

• rt_average ["MRT"] (with alias meanrecurrencetime", as reported in some papers)
• rt_max ["RTmax"]
• rt_entropy ["RTENT"]

Also add nmprt (with key "NMPRT"] for the number of the most probable recurrence time.

There are some keys that vary across sources. Namely, Norbert's paper (2007) uses "ENTR" and "TREND", where the RQA book of 2015 uses "ENT" and "TND". I have followed the latter, which are shorter, but we are now on time to change it.

(I'm also closing #30, which is redundant with this)

[pucicu]

I agree with these names. No problem with “ENT” instead of “ENTR” etc. Very nice!

Am 07.01.2019 um 15:29 schrieb Helios De Rosario notifications@github.com:

After some discussion in #24 https://github.com/JuliaDynamics/RecurrenceAnalysis.jl/issues/24 I propose the following changes in the names of the functions for RQA. It means deprecating three of the older names, and adding a couple of parameters that I have not actually seen reported in papers, like the entropy of vertical lines or the longest recurrence time. But the advantage is that the set of functions and their names follow a more systematic pattern, easier to remember. This is what pyunicorn http://www.pik-potsdam.de/~donges/pyunicorn/ and PyRQA https://pypi.org/project/PyRQA/ also do, so it facilitates understanding for users of both Python and Julia.

(Each function name is accompanied by the key of the corresponding dictionary item returned by rqa in square brackets.)

These conventional names remain without changes:

recurrencerate ["RR"] determinism ["DET"] divergence ["DIV"] laminarity ["LAM"] trappingtime ["TT"] trend ["TND"] In addition, diagonal lines, vertical lines and recurrence times will have functions to calculate their mean and maximum value, and their (Shannon) entropy, with the following common pattern (this may be nicely meta-programmed):

For diagonal lines:

dl_average ["L"] (deprecates avgdiag) dl_max ["Lmax"] (deprecates maxdiag) dl_entropy ["ENT"] (deprecates rqaentropy) For vertical lines:

vl_average (equivalent to trappingtime, which will remain) vl_max ["Vmax"] (deprecates maxdiag) vl_entropy ["VENT"] For recurrence times (all new)

rt_average ["MRT"] (with alias meanrecurrencetime", as reported in some papers) rt_max ["RTmax"] rt_entropy ["RTENT"] Also add nmprt (with key "NMPRT"] for the number of the most probable recurrence time.

There are some keys that vary across sources. Namely, Norbert's paper (2007) uses "ENTR" and "TREND", where the RQA book of 2015 uses "ENT" and "TND". I have followed the latter, which are shorter, but we are now on time to change it.

(I'm also closing #30 https://github.com/JuliaDynamics/RecurrenceAnalysis.jl/issues/30, which is redundant with this)

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/JuliaDynamics/RecurrenceAnalysis.jl/issues/34, or mute the thread https://github.com/notifications/unsubscribe-auth/AA7WkMfjRgb-cKkJ4uiXopWtHLUwBK4Cks5vA1m8gaJpZM4ZzmWQ.

[Datseris]

Excellent I fully agree.

Only on the final point, I vote on ENT and TREND. TND does not have R in it, I would never take it as "trend". The r in the trend is quite strong when used verbally.