holgerteichgraeber / TimeSeriesClustering.jl

Julia implementation of unsupervised learning methods for time series datasets. It provides functionality for clustering and aggregating, detecting motifs, and quantifying similarity between time series datasets.
MIT License
82 stars 22 forks source link

Testing + code coverage for Elias review #97

Closed holgerteichgraeber closed 5 years ago

holgerteichgraeber commented 5 years ago

The branch testing is based off documentation. Before evaluating this PR, please first review #96 .

In #91, there are several TODOs concerning which functions still need test coverage. Let's implement them after this PR.

codecov[bot] commented 5 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (documentation@d483c9e). Click here to learn what that means. The diff coverage is 50%.

Impacted file tree graph

@@               Coverage Diff                @@
##             documentation      #97   +/-   ##
================================================
  Coverage                 ?   64.46%           
================================================
  Files                    ?        9           
  Lines                    ?      515           
  Branches                 ?        0           
================================================
  Hits                     ?      332           
  Misses                   ?      183           
  Partials                 ?        0
Impacted Files Coverage Δ
src/clustering/run_clust.jl 88.54% <100%> (ø)
src/utils/load_data.jl 71.42% <16.66%> (ø)
src/clustering/extreme_vals.jl 84.21% <33.33%> (ø)
src/utils/utils.jl 83.15% <50%> (ø)
src/utils/datastructs.jl 97.36% <75%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d483c9e...200edfc. Read the comment docs.

holgerteichgraeber commented 5 years ago

Codecov Report

❗️ No coverage uploaded for pull request base (documentation@d483c9e). Click here to learn what that means. The diff coverage is 50%.

Impacted file tree graph

@@               Coverage Diff                @@
##             documentation      #97   +/-   ##
================================================
  Coverage                 ?   64.46%           
================================================
  Files                    ?        9           
  Lines                    ?      515           
  Branches                 ?        0           
================================================
  Hits                     ?      332           
  Misses                   ?      183           
  Partials                 ?        0

Impacted Files Coverage Δ
src/clustering/run_clust.jl 88.54% <100%> (ø)
src/utils/load_data.jl 71.42% <16.66%> (ø)
src/clustering/extreme_vals.jl 84.21% <33.33%> (ø)
src/utils/utils.jl 83.15% <50%> (ø)
src/utils/datastructs.jl 97.36% <75%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d483c9e...c53c37c. Read the comment docs.

This happened because the documentation branch does not have coverage, that's to be expected..

holgerteichgraeber commented 5 years ago

Great testing overall! I added a few questions and suggestions to the code. What would you think about a few comments explaining the main process that you use for testing?

Thanks. The comments for testing mostly in test/run_clust.jl or where would you think they are most appropriate?

holgerteichgraeber commented 5 years ago

Added some minor updates on testing and documentation. Already pushed to dev.

YoungFaithful commented 5 years ago

Great testing overall! I added a few questions and suggestions to the code. What would you think about a few comments explaining the main process that you use for testing?

Thanks. The comments for testing mostly in test/run_clust.jl or where would you think they are most appropriate?

I thought about an explanation in test/runtests.jl In case someone else wants to expand the package with their own method and needs to know, how testing works in general.

holgerteichgraeber commented 5 years ago

Great testing overall! I added a few questions and suggestions to the code. What would you think about a few comments explaining the main process that you use for testing?

Thanks. The comments for testing mostly in test/run_clust.jl or where would you think they are most appropriate?

I thought about an explanation in test/runtests.jl In case someone else wants to expand the package with their own method and needs to know, how testing works in general.

Sounds good. Opening an issue to be addressed after name change. #112

holgerteichgraeber commented 5 years ago

Thank you for your comments on this @YoungFaithful . Because this PR was previously merged #98 , closing it here.