JuliaDynamics / TransitionsInTimeseries.jl

Transition Indicators / Early Warning Signals / Regime Shifts / Change Point Detection
MIT License
18 stars 5 forks source link

Improve documentation of Results types #50

Closed Datseris closed 10 months ago

Datseris commented 10 months ago

This PR improves and generalizes the documentation and API associated with the "Results" types. It renames the supertype to IndocatorChangesResults. And further discusses this and the subtypes in the docstrings. Crossreferences things more.

There is one more change here: the default value of the minimum change wmetric window is now infinity. That is because, unless a user requires a minium, no minimum should be enforced.