[REVIEW]: TimeSeriesClustering: An extensible framework in Julia

whedon commented 5 years ago

Submitting author: @holgerteichgraeber (Holger Teichgraeber) Repository: https://github.com/holgerteichgraeber/TimeSeriesClustering.jl Version: v0.5.2 Editor: @danielskatz Reviewer: @jgoldfar, @ahwillia Archive: 10.5281/zenodo.3385349

Status

Status badge code:

HTML: <a href="http://joss.theoj.org/papers/e3975d642975a19f5e2d7e43e3752066"><img src="http://joss.theoj.org/papers/e3975d642975a19f5e2d7e43e3752066/status.svg"></a>
Markdown: [![status](http://joss.theoj.org/papers/e3975d642975a19f5e2d7e43e3752066/status.svg)](http://joss.theoj.org/papers/e3975d642975a19f5e2d7e43e3752066)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@jgoldfar & @ahwillia, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

Make sure you're logged in to your GitHub account
Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @danielskatz know.

✨ Please try and complete your review in the next two weeks ✨

Review checklist for @jgoldfar

Conflict of interest

[x] As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Version: v0.5.2
[x] Authorship: Has the submitting author (@holgerteichgraeber) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
[x] Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

[x] Authors: Does the paper.md file include a list of authors with their affiliations?
[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @ahwillia

Conflict of interest

[x] As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Version: v0.5.2
[x] Authorship: Has the submitting author (@holgerteichgraeber) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
[x] Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

[x] Authors: Does the paper.md file include a list of authors with their affiliations?
[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

whedon commented 5 years ago

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @jgoldfar, @ahwillia it looks like you're currently assigned to review this paper :tada:.

:star: Important :star:

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

For a list of things I can do to help you, just type:

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

whedon commented 5 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 5 years ago

:point_right: Check article proof :page_facing_up: :point_left:

danielskatz commented 5 years ago

Note: @ahwillia is traveling for the next few weeks. It will be about 3 weeks until he can work on this review.

danielskatz commented 5 years ago

👋 @jgoldfar, @ahwillia - We'll do the review here - please read the comments above, and get started when you can. If you have any questions, please ask.

holgerteichgraeber commented 5 years ago

👋 @jgoldfar, @ahwillia - We'll do the review here - please read the comments above, and get started when you can. If you have any questions, please ask.

👋Thank you all for offering to review, I look forward to your comments. Tagging along co-authors @YoungFaithful and @arbrandt for reference.

danielskatz commented 5 years ago

👋 @jgoldfar - have you had a chance to get started?

jgoldfar commented 5 years ago

Yes; I will post my review within a few days

On Jul 26, 2019, at 12:55 PM, Daniel S. Katz notifications@github.com wrote:

👋 @jgoldfar - have you had a chance to get started?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

danielskatz commented 5 years ago

@whedon remind @ahwillia in 7 days

whedon commented 5 years ago

Reminder set for @ahwillia in 7 days

danielskatz commented 5 years ago

Yes; I will post my review within a few days

@jgoldfar - any update on this?

ahwillia commented 5 years ago

Looking through this now. I'm generally very impressed and think we should be able to approve this in short order. I am confirming that I can install and execute the package now.

My biggest piece of feedback is that the README and description of the package should emphasize even more applications. I think this package will be broadly useful to many fields! For example, the first sentence of the README might lead users to think the package is for a very specialized purpose I would recommend editing to something like...

Current: "ClustForOpt is a julia implementation of unsupervised machine learning methods for finding representative periods for energy systems optimization problems."

Revised: "ClustForOpt is a julia implementation of unsupervised machine learning methods for detecting motifs, clustering, and quantifying similarity between time series datasets."

Likewise, in the subsequent paragraphs, I recommend adding some more example applications with citations. Segmentation and clustering of audio datasets should be an easy one to find.

It is of course okay to say something like "this package was originally developed for energy systems optimization" but I think emphasizing the generality of the package and the methods as much as possible will increase the impact of this work.

Full disclosure, I've worked on using very simple time warping methods for neural data (https://www.biorxiv.org/content/10.1101/661165v1), though those data show very different statistics and call for different modeling approaches. But I'm quite enthusiastic about this area of research.

ahwillia commented 5 years ago

One final thought, I don't insist on changing the name of the repo, but something like "TimeSeriesClustering.jl" would seem to better capture the function of the package. The name ClustForOpt doesn't make it super clear what the package does...

Also can the authors comment on the differences between this package and other time series packages in julia (e.g TimeSeries.jl) in the paper / README? It would be nice to give users more guidance on the broader tools available in Julia for these kinds of modeling problems.

whedon commented 5 years ago

:wave: @ahwillia, please update us on how your review is going.

holgerteichgraeber commented 5 years ago

Thank you for your feedback, these are great ideas! I am out for the weekend, and will get back to this next week.

holgerteichgraeber commented 5 years ago

In case that there are any papers that you can recommend to read in the suggested application areas, suggestions are greatly appreciated.

danielskatz commented 5 years ago

👋 @jgoldfar, @ahwillia - can you please use your checklists above to indicate what you think is ok, and what needs to be done, in addition to the comments @ahwillia has posted in this thread, and what I expect @jgoldfar to post soon.

ahwillia commented 5 years ago

Checked my boxes...

@holgerteichgraeber In case that there are any papers that you can recommend to read in the suggested application areas, suggestions are greatly appreciated.

Eamonn Keogh has a variety of methods and application papers to check out (e.g. https://www.cs.ucr.edu/~eamonn/MatrixProfile.html). I'm sure many other research groups have relevant papers as well. Please don't worry about being comprehensive, but the more references you can find the better.

danielskatz commented 5 years ago

👋 @jgoldfar

Yes; I will post my review within a few days

Can you please go ahead and do this? (and check the boxes for items that are complete)

holgerteichgraeber commented 5 years ago

@whedon generate pdf from branch paper

whedon commented 5 years ago

Attempting PDF compilation from custom branch paper. Reticulating splines etc...

whedon commented 5 years ago

:point_right: Check article proof :page_facing_up: :point_left:

holgerteichgraeber commented 5 years ago

@whedon generate pdf from branch paper

Ok, that seems not to have worked. Will push to master branch and revisit.

I will be updating the package to reflect its more general applicability and rename to TimeSeriesClustering.jl. I will update here once complete.

holgerteichgraeber commented 5 years ago

@whedon generate pdf

whedon commented 5 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 5 years ago

PDF failed to compile for issue #1573 with the following error:

Error reading bibliography ./paper.bib (line 344, column 1): unexpected "y" expecting space, ",", white space or "}" Error running filter pandoc-citeproc: Filter returned error status 1 Looks like we failed to compile the PDF

holgerteichgraeber commented 5 years ago

@whedon generate pdf

whedon commented 5 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 5 years ago

PDF failed to compile for issue #1573 with the following error:

Error reading bibliography ./paper.bib (line 344, column 1): unexpected "y" expecting space, ",", white space or "}" Error running filter pandoc-citeproc: Filter returned error status 1 Looks like we failed to compile the PDF

holgerteichgraeber commented 5 years ago

@whedon generate pdf

whedon commented 5 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 5 years ago

:point_right: Check article proof :page_facing_up: :point_left:

holgerteichgraeber commented 5 years ago

@whedon generate pdf

whedon commented 5 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 5 years ago

:point_right: Check article proof :page_facing_up: :point_left:

holgerteichgraeber commented 5 years ago

I am in the process of renaming the package. There is no documentation on how to do that with the new package registry in julia, so I opened an issue in the general registry. Will update here as soon as TimeSeriesClustering.jl is officially registered. Then, the package should be installable using the new name, and the documentation should be updated.

@danielskatz would the name of this issue and the repository name at the top need to be updated?

danielskatz commented 5 years ago

Sorry for the delay - I'm on vacation and just scanning things, and missed this.

But the answer is that we can do what's needed - I'm fairly sure that we will need to change the repo URL in this issue, and we will probably change the name of the issue as well.

danielskatz commented 5 years ago

👋 @jgoldfar

Yes; I will post my review within a few days

Can you please go ahead and do this? (and check the boxes for items that are complete)

jgoldfar commented 5 years ago

Hello all; my sincere apologies for the delay as I was unexpectedly without internet connectivity.

Alex's comments above are spot on. I agree that this is a useful package worth moving forward in the process, modulo the package renaming already discussed above.

holgerteichgraeber commented 5 years ago

Thank you all for your comments. The package has been renamed, I am now just making sure that the automatic testing through travis and documentation are updated to create a new fully working version, should be all done in the coming days.

holgerteichgraeber commented 5 years ago

Thank you for your feedback, this has been really helpful!

The package is now renamed and officially registered in the Julia registries as TimeSeriesClustering. I have updated the documentation, codecov, and travis.

I have also rewritten the paper to reflect the broader application areas (new title and content). As always, any feedback appreciated.

holgerteichgraeber commented 5 years ago

@whedon generate pdf

whedon commented 5 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 5 years ago

:point_right: Check article proof :page_facing_up: :point_left:

danielskatz commented 5 years ago

@arfon - note that this has been renamed - do we need to do anything to tell whedon this, or in an internal database?

danielskatz commented 5 years ago

👋 @jgoldfar, @ahwillia - can you confirm that you are happy with this now?

arfon commented 5 years ago

@arfon - note that this has been renamed - do we need to do anything to tell whedon this, or in an internal database?

The repository has been renamed or the paper, or both?

holgerteichgraeber commented 5 years ago

@arfon - note that this has been renamed - do we need to do anything to tell whedon this, or in an internal database?

The repository has been renamed or the paper, or both?

Both the paper and the repository (and thus also the link to the repository: https://github.com/holgerteichgraeber/TimeSeriesClustering.jl )

arfon commented 5 years ago

Got it, thanks. I've updated the links in the JOSS database.

ahwillia commented 5 years ago

👋 @jgoldfar, @ahwillia - can you confirm that you are happy with this now?

Yes this looks good to me!

openjournals / joss-reviews