JuliaDynamics / TransitionsInTimeseries.jl

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

Add developers doc; accordingly rename abstract supertypes #72

Closed Datseris closed 6 months ago

Datseris commented 6 months ago

Closes #71

This adds a new page "Developers docs" that outlines how to contribute new pipelines to the software.

Additionally, I renamed the abstract types, and the core documentation strings, to talk about only two things: "changes" and "statistically significant changes" the latter being equivalent with "transitions".

I wanted to move away from referring to "indicators" all the time, as we have already discussed that sometimes an indicator is not used, only a change metric is used.

codecov-commenter commented 6 months ago

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (b1d3387) 36.42% compared to head (9e1706c) 45.22%.

Files Patch % Lines
src/significance/basic_stat_significance.jl 0.00% 3 Missing :warning:
src/analysis/segmented_window.jl 0.00% 1 Missing :warning:
src/significance/api_significance.jl 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #72 +/- ## ========================================== + Coverage 36.42% 45.22% +8.79% ========================================== Files 18 17 -1 Lines 442 356 -86 ========================================== Hits 161 161 + Misses 281 195 -86 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.