search

openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
725 stars 38 forks source link

[REVIEW]: fABBA: A Python library for the fast symbolic approximation of time series #6294

Closed editorialbot closed 8 months ago

editorialbot commented 10 months ago

Submitting author: !--author-handle-->@chenxinye<!--end-author-handle-- (Xinye Chen) Repository: https://github.com/nla-group/fABBA Branch with paper.md (empty if default branch): master Version: 1.2.1 Editor: !--editor-->@lrnv<!--end-editor-- Reviewers: @Karangupta1994, @allie-tatarian Archive: 10.5281/zenodo.10885652

Status

status

Status badge code:

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

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

@Karangupta1994 & @allie-tatarian, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

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

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

📝 Checklist for @allie-tatarian

📝 Checklist for @Karangupta1994

Karangupta1994 commented 8 months ago

Hi @lrnv, @chenxinye Can you please share the link for the paper? I have run all the examples as listed on my machine and they are working. I now need to review the paper

lrnv commented 8 months ago

@editorialbot generate pdf

editorialbot commented 8 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

Karangupta1994 commented 8 months ago

@lrnv Thank you. I have finished my review.

lrnv commented 8 months ago

@Karangupta1994 perfect then ! It is customary for reviewers to give an overall statement about what they think could be done to improve the package / the paper, if they think the package is useful, how they feel about it, etc. Do you have anything that you would like to say to the authors, request, etc ? Sky's the limit.

Karangupta1994 commented 8 months ago

@lrnv . Below are some points that authors could consider:

  1. In the paper, it would be great to introduce some datasets and show the step-by-step procedures of using the library and interpreting the results.
  2. Run-time or performance metrics comparison between old and new methodology
  3. Sometimes, what I have observed is that in the case of new packages/libraries, they are not compatible with the python/numpy/pandas version. It would be great if we could also mention the python/numpy/pandas version that they should be on to avoid run-time failure.

Rest all looks good. I will share more feedback if I have any.

lrnv commented 8 months ago

@chenxinye Is there somewhere is your documentation a point htat would address @Karangupta1994 third remark about compatibility with python/np/pd versions ? If no, would you accept to add such a statement ?

After that, I think we all agree that this is very good work on your side and we'll start the acceptation and publication process. Congratz!

chenxinye commented 8 months ago

Hi @Karangupta1994 Many thanks for the insightful suggestions.

For (1), thanks for the great advice, I add some data source to https://github.com/nla-group/fABBA/blob/master/README.md#checkered_flag-examples The comment is: To play fABBA further with real datasets, we recommend users start with UCI Repository and UCR Archive.

For (2) I think the paper of fABBA (see https://dl.acm.org/doi/full/10.1145/3532622), which provides full description of evalution.

For (3) I just updated in REDEAME.md and documentation (https://fabba.readthedocs.io/en/latest/quickstart.html) to specify the version of dependencies required.

Best regards!

chenxinye commented 8 months ago

@chenxinye Is there somewhere is your documentation a point htat would address @Karangupta1994 third remark about compatibility with python/np/pd versions ? If no, would you accept to add such a statement ?

After that, I think we all agree that this is very good work on your side and we'll start the acceptation and publication process. Congratz!

Hi @lrnv

I should add the statement (details as mentioned in the last comment), please let me know if I need add more.

Many thanks!

lrnv commented 8 months ago

That is great. Give me a bit of time to go through the repo myself this week and then we'll launch the acceptation.

lrnv commented 8 months ago

@editorialbot generate pdf

editorialbot commented 8 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

lrnv commented 8 months ago

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Editor Tasks Prior to Acceptance

lrnv commented 8 months ago

@chenxinye Woul you please go through the author's checklist I just generated and give me a report ?

chenxinye commented 8 months ago

Hi @lrnv

Many thanks!

lrnv commented 8 months ago

@editorialbot set 10.5281/zenodo.10885652 as archive

editorialbot commented 8 months ago

Done! archive is now 10.5281/zenodo.10885652

lrnv commented 8 months ago

@editorialbot set 1.2.1 as version

editorialbot commented 8 months ago

Done! version is now 1.2.1

lrnv commented 8 months ago

@chenxinye Licence on github says BSD 3-Clause while is says CC4.0 on zenodo ? Could you fix one or the other ?

chenxinye commented 8 months ago

Hi @lrnv Now get it corrected. Cheers!

lrnv commented 8 months ago

@editorialbot generate pdf

lrnv commented 8 months ago

@editorialbot check references

editorialbot commented 8 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

editorialbot commented 8 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1007/s10618-020-00689-6 is OK
- 10.1109/tit.1982.1056489 is OK
- 10.1145/882082.882086 is OK
- 10.1145/3532622 is OK
- 10.1016/j.is.2023.102294 is OK
- 10.1007/978-3-031-24378-3_4 is OK
- 10.1007/s10618-007-0064-z is OK
- 10.1109/seed55351.2022.00016 is OK
- 10.48550/arXiv.2003.05672 is OK
- 10.1016/j.ress.2023.109123 is OK
- 10.1145/3448672 is OK

MISSING DOIs

- No DOI given, and none found for title: Scikit-learn: Machine Learning in Python

INVALID DOIs

- None
lrnv commented 8 months ago

@editorialbot recommend-accept

editorialbot commented 8 months ago 
Attempting dry run of processing paper acceptance...
editorialbot commented 8 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1007/s10618-020-00689-6 is OK
- 10.1109/tit.1982.1056489 is OK
- 10.1145/882082.882086 is OK
- 10.1145/3532622 is OK
- 10.1016/j.is.2023.102294 is OK
- 10.1007/978-3-031-24378-3_4 is OK
- 10.1007/s10618-007-0064-z is OK
- 10.1109/seed55351.2022.00016 is OK
- 10.48550/arXiv.2003.05672 is OK
- 10.1016/j.ress.2023.109123 is OK
- 10.1145/3448672 is OK

MISSING DOIs

- No DOI given, and none found for title: Scikit-learn: Machine Learning in Python

INVALID DOIs

- None
editorialbot commented 8 months ago

:wave: @openjournals/dsais-eics, this paper is ready to be accepted and published.

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5181, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

chenxinye commented 8 months ago

Hi @lrnv I would need to add some comments in Acknowledgement, can I?

``Stefan Güttel acknowledges a Royal Society Industry Fellowship IF/R1/231032. Xinye Chen is supported by the European Union (ERC, inEXASCALE, 101075632). Views and opinions expressed are those of the authors only and do not necessarily reflect those of the European Union or the European Research Council. Neither the European Union nor the granting authority can be held responsible for them.''

Can I?

lrnv commented 8 months ago

Yes you can of course.

lrnv commented 8 months ago

Just regenerate the paper after that, and I'll re-recomand-accept

chenxinye commented 8 months ago

Hi @lrnv We just proofreaded, now it is okay for us.

Many thanks

chenxinye commented 8 months ago

@editorialbot generate pdf

editorialbot commented 8 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

lrnv commented 8 months ago

@editorialbot recomand-accept

editorialbot commented 8 months ago

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

lrnv commented 8 months ago

@editorialbot recommend-accept

editorialbot commented 8 months ago 
Attempting dry run of processing paper acceptance...
editorialbot commented 8 months ago 
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1007/s10618-020-00689-6 is OK
- 10.1109/tit.1982.1056489 is OK
- 10.1145/882082.882086 is OK
- 10.1145/3532622 is OK
- 10.1016/j.is.2023.102294 is OK
- 10.1007/978-3-031-24378-3_4 is OK
- 10.1007/s10618-007-0064-z is OK
- 10.1109/seed55351.2022.00016 is OK
- 10.48550/arXiv.2003.05672 is OK
- 10.1016/j.ress.2023.109123 is OK
- 10.1145/3448672 is OK

MISSING DOIs

- No DOI given, and none found for title: Scikit-learn: Machine Learning in Python

INVALID DOIs

- None
editorialbot commented 8 months ago

:wave: @openjournals/dsais-eics, this paper is ready to be accepted and published.

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5187, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

arfon commented 8 months ago

@editorialbot accept

editorialbot commented 8 months ago 
Doing it live! Attempting automated processing of paper acceptance...
editorialbot commented 8 months ago

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

``` cff-version: "1.2.0" authors: - family-names: Chen given-names: Xinye orcid: "https://orcid.org/0000-0003-1778-393X" - family-names: Güttel given-names: Stefan orcid: "https://orcid.org/0000-0003-1494-4478" doi: 10.5281/zenodo.10885652 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Chen given-names: Xinye orcid: "https://orcid.org/0000-0003-1778-393X" - family-names: Güttel given-names: Stefan orcid: "https://orcid.org/0000-0003-1494-4478" date-published: 2024-03-30 doi: 10.21105/joss.06294 issn: 2475-9066 issue: 95 journal: Journal of Open Source Software publisher: name: Open Journals start: 6294 title: "fABBA: A Python library for the fast symbolic approximation of time series" type: article url: "https://joss.theoj.org/papers/10.21105/joss.06294" volume: 9 title: "*fABBA*: A Python library for the fast symbolic approximation of time series" ```

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

editorialbot commented 8 months ago

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

editorialbot commented 8 months ago

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/5195
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06294
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

arfon commented 8 months ago

@Karangupta1994, @allie-tatarian – many thanks for your reviews here and to @lrnv for editing this submission! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨

@chenxinye – your paper is now accepted and published in JOSS :zap::rocket::boom:

editorialbot commented 8 months ago

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06294/status.svg)](https://doi.org/10.21105/joss.06294)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.06294">
  <img src="https://joss.theoj.org/papers/10.21105/joss.06294/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.06294/status.svg
   :target: https://doi.org/10.21105/joss.06294

This is how it will look in your documentation:

DOI

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following: