Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REVIEW]: repytah: An Open-Source Python Package That Builds Aligned Hierarchies for Sequential Data Streams #5213

Closed
editorialbot opened this issue Mar 5, 2023 · 77 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 7 (CSISM) Computer science, Information Science, and Mathematics

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Mar 5, 2023

Submitting author: @kmkinnaird (Katherine M. Kinnaird)
Repository: https://github.com/smith-tinkerlab/repytah
Branch with paper.md (empty if default branch):
Version: v0.1.2
Editor: @jbytecode
Reviewers: @Rocsg, @ranzhengcode
Archive: 10.5281/zenodo.7931423

Status

status

Status badge code:

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

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

@Rocsg & @ranzhengcode, 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 @jbytecode 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 @Rocsg

📝 Checklist for @ranzhengcode

@editorialbot editorialbot added Python review TeX Track: 7 (CSISM) Computer science, Information Science, and Mathematics labels Mar 5, 2023
@editorialbot
Copy link
Collaborator Author

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

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

@editorialbot commands

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

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=1.18 s (62.7 files/s, 32592.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JavaScript                      11           4448           4376          16488
Python                          15            987           1466           2455
HTML                             8           1023             24           1843
CSS                              3            194             32            776
Jupyter Notebook                 6              0           2112            659
Markdown                         6            120              0            281
YAML                             4             15              6            255
reStructuredText                16            201            310            126
SVG                              1              0              0             86
TeX                              1             12              0             85
DOS Batch                        1              8              1             26
make                             1              4              7              9
TOML                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                            74           7012           8334          23092
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 987

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.21105/joss.03326 is OK
- 10.1109/MSP.2018.2875349 is OK
- 10.25080/Majora-7b98e3ed-003 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@jbytecode
Copy link

Dear Reviewers @Rocsg and @ranzhengcode

This is the review thread. Firstly, type

@editorialbot generate my checklist

to generate your own checklist. In that checklist, there are 23 check items. Whenever you complete the corresponding task, you can check off them.

Please write your comments as separate posts and do not modify your checklist descriptions.

The review process is interactive so you can always interact with the authors (@kmkinnaird ), reviewers, and the editor (me). You can also create issues and pull requests in the target repo. Please do mention this thread's URL in the issues so we can keep tracking what is going on out of our world.

Please do not hesitate to ask me about anything, anytime.

Thank you in advance!

@Rocsg
Copy link

Rocsg commented Mar 6, 2023

Review checklist for @Rocsg

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/smith-tinkerlab/repytah?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@kmkinnaird) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • 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

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • 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

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@ranzhengcode
Copy link

ranzhengcode commented Mar 6, 2023

Review checklist for @ranzhengcode

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/smith-tinkerlab/repytah?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@kmkinnaird) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • 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

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • 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

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@Rocsg
Copy link

Rocsg commented Mar 6, 2023

👋 @jbytecode @ranzhengcode
I submitted an issue with my first round of comments, there :

smith-tinkerlab/repytah#426

Have a nice week

Romain

@jbytecode
Copy link

@Rocsg - thank you for your comments.

@ranzhengcode - It seems you've performed a full check in a relatively short time. thank you. could you please provide your review and thoughts here or in issues in the target repo? thank you in advance.

@ranzhengcode
Copy link

@jbytecode Dear jbytecode, I have completely checked and tried repytah on my computer and was able to run all instances properly according to the author's instructions. As I am not an expert in music and data processing, I don't have a more pertinent advice for authors, but I think the work is still very interesting to accept.

@kmkinnaird
Copy link

Thank you @Rocsg for your detailed review. We have responded in the issue that you created smith-tinkerlab/repytah#426

Thank you @ranzhengcode for your kind words. Let us know if there is anything additional that you would like us to add or if there are questions that we can answer regarding the changes made in response to @Rocsg's review

@Rocsg
Copy link

Rocsg commented Mar 17, 2023

Hello @jbytecode . I did receive the answers and I am planning to fulfill my checklist early next week. I keep both of you in touch. I Wish you all a nice weekend.

Romain

@Rocsg
Copy link

Rocsg commented Apr 5, 2023

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@jbytecode
Copy link

jbytecode commented Apr 7, 2023

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

  • Double check authors and affiliations (including ORCIDs)
  • Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSS paper.
  • Archive the release on Zenodo/figshare/etc and post the DOI here.
  • Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSS paper.
  • Make sure that the license listed for the archive is the same as the software license.

Editor Tasks Prior to Acceptance

  • Read the text of the paper and offer comments/corrections (as either a list or a PR)
  • Check the references in the paper for corrections (e.g. capitalization)
  • Check that the archive title, author list, version tag, and the license are correct
  • Set archive DOI with @editorialbot set <DOI here> as archive
  • Set version with @editorialbot set <version here> as version
  • Double check rendering of paper with @editorialbot generate pdf
  • Specifically check the references with @editorialbot check references and ask author(s) to update as needed
  • Recommend acceptance with @editorialbot recommend-accept

@jbytecode
Copy link

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.21105/joss.03326 is OK
- 10.1109/MSP.2018.2875349 is OK
- 10.25080/Majora-7b98e3ed-003 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@jbytecode
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@jbytecode
Copy link

@kmkinnaird - I've just sent a pull request that includes some minor changes on both the manuscript and the bibliography:

smith-tinkerlab/repytah#428

Please review the changes. If you are agreed with them, please merge.

Thank you in advance.

@kmkinnaird
Copy link

I see both the Post Review Checklist and your comment above. I will complete the checklist and review the changes by May 5th.

Thank you!

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.7931423

@jbytecode
Copy link

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.21105/joss.03326 is OK
- 10.1109/MSP.2018.2875349 is OK
- 10.25080/Majora-7b98e3ed-003 is OK
- 10.1109/icassp.2006.1661198 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@jbytecode
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@jbytecode
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.21105/joss.03326 is OK
- 10.1109/MSP.2018.2875349 is OK
- 10.25080/Majora-7b98e3ed-003 is OK
- 10.1109/icassp.2006.1661198 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/csism-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4224, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label May 13, 2023
@danielskatz
Copy link

@kmkinnaird - I'm the track editor who will handle the final processing of your submission. I've proofread the draft, and the paper looks fine to me, but some references need work. Specifically, there are a few references that are of type article that should be of type inproceedings, such as Casey & Slaney 2006a, Casey & Slaney 2006b, Casey & Slaney 2007, and Sapp 2005. The conference name should also be written out in these cases, as it is in others already. Please fix these, then ping me here, and I'll continue the process of acceptance and publication.

@kmkinnaird
Copy link

@danielskatz - Thanks for your note and for introducing yourself.

I believe that I've fixed all the references to include the full conference names as well as consistent presentation for the author names. The current draft is in the main branch of the repo

One question: are the use of acronyms correct or should I remove them?

@danielskatz
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.21105/joss.03326 is OK
- 10.1109/MSP.2018.2875349 is OK
- 10.25080/Majora-7b98e3ed-003 is OK
- 10.1109/icassp.2006.1661198 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/csism-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4225, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@danielskatz
Copy link

This looks good now - thanks!

@danielskatz
Copy link

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

Doing it live! Attempting automated processing of paper acceptance...

@editorialbot
Copy link
Collaborator Author

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: Jia
  given-names: Chenhui
- family-names: Carpenter
  given-names: Lizette
- family-names: Tran
  given-names: Thu
- family-names: Liu
  given-names: Amanda Y.
- family-names: Yeutseyeva
  given-names: Sasha
- family-names: Tapal
  given-names: Marium
  orcid: "https://orcid.org/0000-0001-5093-6462"
- family-names: Wang
  given-names: Yingke
- family-names: Zhao
  given-names: Zoie Kexin
- family-names: Moody
  given-names: Jordan
- family-names: Nava
  given-names: Denise
- family-names: Donaher
  given-names: Eleanor
- family-names: Jiang
  given-names: Lillian Yushu
- family-names: Bruncati
  given-names: Ben
- family-names: Kinnaird
  given-names: Katherine M.
  orcid: "https://orcid.org/0000-0002-0435-8996"
contact:
- family-names: Kinnaird
  given-names: Katherine M.
  orcid: "https://orcid.org/0000-0002-0435-8996"
doi: 10.5281/zenodo.7931423
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Jia
    given-names: Chenhui
  - family-names: Carpenter
    given-names: Lizette
  - family-names: Tran
    given-names: Thu
  - family-names: Liu
    given-names: Amanda Y.
  - family-names: Yeutseyeva
    given-names: Sasha
  - family-names: Tapal
    given-names: Marium
    orcid: "https://orcid.org/0000-0001-5093-6462"
  - family-names: Wang
    given-names: Yingke
  - family-names: Zhao
    given-names: Zoie Kexin
  - family-names: Moody
    given-names: Jordan
  - family-names: Nava
    given-names: Denise
  - family-names: Donaher
    given-names: Eleanor
  - family-names: Jiang
    given-names: Lillian Yushu
  - family-names: Bruncati
    given-names: Ben
  - family-names: Kinnaird
    given-names: Katherine M.
    orcid: "https://orcid.org/0000-0002-0435-8996"
  date-published: 2023-05-15
  doi: 10.21105/joss.05213
  issn: 2475-9066
  issue: 85
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5213
  title: "repytah: An Open-Source Python Package for Building Aligned
    Hierarchies for Sequential Data"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05213"
  volume: 8
title: "`repytah`: An Open-Source Python Package for Building Aligned
  Hierarchies for Sequential Data"

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
Copy link
Collaborator Author

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 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 👉 Creating pull request for 10.21105.joss.05213 joss-papers#4226
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05213
  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...

@editorialbot editorialbot added accepted published Papers published in JOSS labels May 15, 2023
@danielskatz
Copy link

Congratulations to @kmkinnaird (Katherine M. Kinnaird) and co-authors!!

And thanks to @Rocsg and @ranzhengcode for reviewing, and to @jbytecode for editing!
We couldn't do this without your volunteering

(I'll also note that the DOI doesn't resolve, and it normally should by now - I'll leave this open until it is working.)

@kmkinnaird
Copy link

Thank you @Rocsg, @ranzhengcode, @jbytecode, and @danielskatz for all your work during this reviewing process. It was a really great reviewing experience!

@danielskatz
Copy link

the DOI is now resolving for me - thanks again to everyone!

@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

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.05213/status.svg)](https://doi.org/10.21105/joss.05213)

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

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

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 7 (CSISM) Computer science, Information Science, and Mathematics
Projects
None yet
Development

No branches or pull requests

6 participants