search

JuliaDynamics / RecurrenceAnalysis.jl

Recurrence Quantification Analysis in Julia
https://juliadynamics.github.io/RecurrenceAnalysis.jl/stable/
MIT License
45 stars 12 forks source link

[DOC] Enrich RQA docstrings with comments for usefulness / understanding #65

Closed Datseris closed 5 years ago

Datseris commented 5 years ago

I suggest that little by little we start enriching the docstrings of all RQA functions by copy/pasting the relevant text from Norbert's book. This will really make the RQA page a "library" page (which is my life-long dream with DynamicalSystems.jl).

For example, in the determinism we can copy paste:

Systems possessing deterministic (rule-obeying) dynamics are characterized by diagonal lines indicating repeating recurrences within a state. For periodic signals the diagonal lines are long. For chaotic signals the diagonal lines are short. For stochastic signals the diagonal lines are absent, save for chance recurrences forming very short lines. DET can be interpreted as the predictability of the system more so for periodic behaviors than chaotic processes. But it must be realized that DET does not have the same strict meaning of the determinism of a process.

And so on and so forth.

heliosdrm commented 5 years ago

I like the "library" approach of DynamicalSystems.jl. Nevertheless we should take care about how much we copy from a single source if it doesn't have an open license; we don't want to make Norbert's editors angry. :smile:

Datseris commented 5 years ago

Yes, immediatelly after I posted this I thought about it and realized copying is not the best approach for two reasons:

  1. Licencing
  2. We don't have to be so verbose. A brief summary is what fits best I think.
pucicu commented 5 years ago

I could also have a final look or prepare something if you like.

Am 25.01.2019 um 13:30 schrieb George Datseris notifications@github.com:

Yes, immediatelly after I posted this I thought about it and realized copying is not the best approach for two reasons:

Licencing We don't have to be so verbose. A brief summary is what fits best I think. — 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/65#issuecomment-457558642, or mute the thread https://github.com/notifications/unsubscribe-auth/AA7WkHiAaLKEy-Zy_d-pHcRiQXVyGVuvks5vGvjqgaJpZM4aSgx9.

Datseris commented 5 years ago

I think this is solved now, since quite a lot of time actually...

Datseris commented 5 years ago

https://juliadynamics.github.io/DynamicalSystems.jl/dev/rqa/quantification/#classical-rqa-measures