JuliaDynamics / ComplexityMeasures.jl

Estimators for probabilities, entropies, and other complexity measures derived from data in the context of nonlinear dynamics and complex systems
MIT License
56 stars 14 forks source link

Use DocumenterCitations.jl for references #302

Closed kahaaga closed 1 year ago

kahaaga commented 1 year ago

Fixes #301.

The docs are here.

Other changes

codecov[bot] commented 1 year ago

Codecov Report

Merging #302 (0c74d11) into main (231ae8c) will decrease coverage by 0.82%. The diff coverage is n/a.

:exclamation: Current head 0c74d11 differs from pull request most recent head 9fd002d. Consider uploading reports for the commit 9fd002d to get more accurate results

@@            Coverage Diff             @@
##             main     #302      +/-   ##
==========================================
- Coverage   87.22%   86.41%   -0.82%     
==========================================
  Files          75       72       -3     
  Lines        1848     1767      -81     
==========================================
- Hits         1612     1527      -85     
- Misses        236      240       +4     
Files Changed Coverage Δ
src/complexity_measures/approximate_entropy.jl 95.00% <ø> (ø)
src/complexity_measures/lempel_ziv.jl 100.00% <ø> (ø)
src/complexity_measures/missing_dispersion.jl 100.00% <ø> (ø)
.../complexity_measures/reverse_dispersion_entropy.jl 100.00% <ø> (ø)
src/complexity_measures/sample_entropy.jl 93.54% <ø> (ø)
src/complexity_measures/statistical_complexity.jl 100.00% <ø> (ø)
src/core/information_measures.jl 0.00% <ø> (ø)
...ferential_info_estimators/nearest_neighbors/Gao.jl 100.00% <ø> (ø)
...rential_info_estimators/nearest_neighbors/Goria.jl 100.00% <ø> (ø)
...estimators/nearest_neighbors/KozachenkoLeonenko.jl 100.00% <ø> (ø)
... and 43 more

... and 4 files with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

Datseris commented 1 year ago

How does this PR interact with the ongoing #299 ? I am assuming there will be massive conflicts to resolve if either gets merged firstr.

kahaaga commented 1 year ago

How does this PR interact with the ongoing https://github.com/JuliaDynamics/ComplexityMeasures.jl/pull/299 ? I am assuming there will be massive conflicts to resolve if either gets merged firstr.

There will be less work to resolve merge conflicts if #299 is merged first. I'll wait with merging this until that PR is done.