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]: MIDI.jl: Intuitive handling of MIDI data made for musicians #1166

Closed
whedon opened this Issue Jan 12, 2019 · 175 comments

Comments

Projects
None yet
7 participants
@whedon
Copy link
Collaborator

whedon commented Jan 12, 2019

Submitting author: @Datseris (George Datserus)
Repository: https://github.com/JuliaMusic/MIDI.jl
Version: v1.1.3
Editor: @Kevin-Mattheus-Moerman
Reviewer: @ssfrr, @jfsantos
Archive: 10.5281/zenodo.2591437

Status

status

Status badge code:

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

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) 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

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

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

The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @Kevin-Mattheus-Moerman know.

Please try and complete your review in the next two weeks

Review checklist for @ssfrr

Conflict of interest

Code of Conduct

General checks

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

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 function 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

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

Review checklist for @jfsantos

Conflict of interest

Code of Conduct

General checks

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

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 function 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

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

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 12, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @ssfrr, it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐️ Important ⭐️

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:

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

watching

  1. 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
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 12, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 12, 2019

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 12, 2019

@Datseris, @ssfrr, @jfsantos, this is where the review takes place. There are instructions at the top of this issue as well as a check list which will guide you through the process. If all boxes are ticked and reviewers recommend acceptance this submission will be accepted in JOSS.

You can comment on minor things here and we encourage your to use check lists (- [ ] in markdown). Larger/longer issues are better discussed in a separate issue which you can open on the submission repository and refer to here.

Thanks again for helping with the review process!!!!!

Let me know if you have any questions.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 12, 2019

@Datseris can you work on fixing that figure in the paper? Let me know if you need help.

@Datseris

This comment has been minimized.

Copy link

Datseris commented Jan 12, 2019

@Kevin-Mattheus-Moerman I do not know how to fix this figure, as I said in a previous comment in the previous issue. It is a standard .png figure that is included with the standard ![description](figure) format. The figure doesn't have overly big whitespace either.

From my perspective this is a problem of the "compilation/pdf-generation" procedure. If you know what I have to do then please let me know.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 12, 2019

@arfon any idea what is causing the figure to be off center in this paper?

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 12, 2019

@Datseris looks a bit like it is an inline picture so I tried to add extra lines in the PR JuliaMusic/MIDI.jl#111.

@Datseris

This comment has been minimized.

Copy link

Datseris commented Jan 12, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 12, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 12, 2019

@Datseris

This comment has been minimized.

Copy link

Datseris commented Jan 12, 2019

Thank you Kevin, it worked. I'll add a better caption now...

@Datseris

This comment has been minimized.

Copy link

Datseris commented Jan 20, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 20, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Jan 20, 2019

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 21, 2019

@ssfrr, @jfsantos, can you give me an indication as to when you think you'll be able to do this review? Let me know if you have questions. Thanks!

@jfsantos

This comment has been minimized.

Copy link
Collaborator

jfsantos commented Jan 22, 2019

@Datseris

This comment has been minimized.

Copy link

Datseris commented Jan 25, 2019

Hello @Kevin-Mattheus-Moerman , @jfsantos , @ssfrr . While I was trying to improve MIDI.jl I realized that I had to do a breaking bugfix. If you are interested you may look at JuliaMusic/MIDI.jl#112 but this is in no way relevant to the paper.

Although this is a breaking change it is a bugfix and thus does not require a major version increment. Regardless, I have released version 1.1 that includes a warning of this change. if possible, please associate this paper with version 1.1 and not with version 1.0. Thank you.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Jan 31, 2019

@ssfrr, @jfsantos can you give an update on the review process? Thanks!

@ssfrr

This comment has been minimized.

Copy link
Collaborator

ssfrr commented Jan 31, 2019

Hi Kevin, sorry for the delay. I should be able to take a look at this next week

@jfsantos

This comment has been minimized.

Copy link
Collaborator

jfsantos commented Jan 31, 2019

@Datseris

This comment has been minimized.

Copy link

Datseris commented Feb 9, 2019

Uhm, excuse me, but I believe I have to bump this.

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Feb 10, 2019

@ssfrr, @jfsantos sorry to bother you again but it would be great if you could get started with this review. Thanks!

@Kevin-Mattheus-Moerman

This comment has been minimized.

Copy link
Member

Kevin-Mattheus-Moerman commented Feb 10, 2019

@Datseris apologies for the delay encountered so far

@Datseris

This comment has been minimized.

Copy link

Datseris commented Feb 10, 2019

@Kevin-Mattheus-Moerman it's no problem, and I certainly hope I didn't come as across as impolite! It's because (I assume) we are all doing these things voluntarily as side projects that it is easy to forget things. So a reminder can be helpful in such cases.

@jfsantos

This comment has been minimized.

Copy link
Collaborator

jfsantos commented Feb 15, 2019

Hello all, I just started my review. The version I get from Github is 1.1.1 but the review form says 1.0.0. The paper doesn't mention a specific version, so I guess that is a non-issue?

@jfsantos

This comment has been minimized.

Copy link
Collaborator

jfsantos commented Feb 15, 2019

Minor issues:

  • The version I get from Github is 1.1.1 but the review form says 1.0.0 (the actual paper doesn't mention a specific version, so I guess this is either a non-issue or the paper should specify which version it describes)
  • Most of the references are missing a DOI.
  • Figure 1 is mentioned in the text as appearing right below the text, but is actually rendered on the next page. Please fix the text and point the reader to Figure 1 instead of assuming it is going to be rendered on a specific position.
@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 13, 2019

@whedon check references

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 13, 2019

Attempting to check references...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 13, 2019


OK DOIs

- 10.1137/141000671 is OK
- 10.1037/a0024323 is OK
- 10.1525/mp.2010.27.3.157 is OK
- 10.1177/1029864913486793 is OK
- 10.1525/mp.2013.30.5.497 is OK
- 10.3389/fpsyg.2016.01487 is OK
- 10.1080/09298215.2017.1355394 is OK
- 10.1371/journal.pone.0026457 is OK
- 10.1371/journal.pone.0127902 is OK
- 10.1371/journal.pone.0186361 is OK
- 10.1073/pnas.1324142111 is OK

MISSING DOIs

- https://doi.org/10.1109/icassp.2016.7471641 may be missing for title: Intuitive analysis, creation and manipulation of MIDI data with pretty_midi

INVALID DOIs

- None
@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 13, 2019

Perfect, I removed all unused references! (The reference you see above without DOI does not have an associated DOI to it)

@labarba

This comment has been minimized.

Copy link
Member

labarba commented Mar 13, 2019

Do you want to add caps protection, {MIDI}, in the title, so it appears in upper case?

@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 13, 2019

@labarba Thanks for the suggestion. I did that now in the latest commit.

@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 13, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 13, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 13, 2019

@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 14, 2019

@labarba Putting {} in the title in the markdown file didn't work so I removed it. I'd prefer to continue with the publication process instead of adding caps protection.

@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 14, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

@labarba

This comment has been minimized.

Copy link
Member

labarba commented Mar 14, 2019

@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 14, 2019

Okay done this now @labarba .

@labarba

This comment has been minimized.

Copy link
Member

labarba commented Mar 14, 2019

@whedon accept

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

Attempting dry run of processing paper acceptance...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019


OK DOIs

- 10.1137/141000671 is OK
- 10.1037/a0024323 is OK
- 10.1525/mp.2010.27.3.157 is OK
- 10.1177/1029864913486793 is OK
- 10.1525/mp.2013.30.5.497 is OK
- 10.3389/fpsyg.2016.01487 is OK
- 10.1080/09298215.2017.1355394 is OK
- 10.1371/journal.pone.0026457 is OK
- 10.1371/journal.pone.0127902 is OK
- 10.1371/journal.pone.0186361 is OK
- 10.1073/pnas.1324142111 is OK

MISSING DOIs

- https://doi.org/10.1109/icassp.2016.7471641 may be missing for title: Intuitive analysis, creation and manipulation of MIDI data with pretty_midi

INVALID DOIs

- None
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

Check final proof 👉 openjournals/joss-papers#552

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#552, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true
@labarba

This comment has been minimized.

Copy link
Member

labarba commented Mar 14, 2019

@whedon accept deposit=true

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

🚨🚨🚨 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 👉 openjournals/joss-papers#553
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01166
  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...

@labarba

This comment has been minimized.

Copy link
Member

labarba commented Mar 14, 2019

Congratulations, @Datseris, your JOSS paper is now published!

Sincere thanks to the editor: @Kevin-Mattheus-Moerman, and reviewers: @ssfrr, @jfsantos 🙏

@labarba labarba closed this Mar 14, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

🎉🎉🎉 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](http://joss.theoj.org/papers/10.21105/joss.01166/status.svg)](https://doi.org/10.21105/joss.01166)

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

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

This is how it will look in your documentation:

DOI

We need your help!

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:

@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 14, 2019

Thank you very much.

@labarba

This comment has been minimized.

@Datseris

This comment has been minimized.

Copy link

Datseris commented Mar 14, 2019

I just want to be on the safe side, since doi2bib.org cannot find the DOI of this publication.

Is the following BibTeX entry the correct one?

@article{Datseris2019,
  doi = {10.21105/joss.01166},
  url = {https://doi.org/10.21105/joss.01166},
  year  = {2019},
  month = {mar},
  publisher = {The Open Journal},
  volume = {4},
  number = {35},
  pages = {1166},
  author = {George Datseris and Joel Hobson},
  title = {{MIDI}.jl: Simple and intuitive handling of MIDI data.},
  journal = {The Journal of Open Source Software}
}
@labarba

This comment has been minimized.

Copy link
Member

labarba commented Mar 14, 2019

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Mar 20, 2019

According to https://www.doi2bib.org/bib/10.21105%2Fjoss.01166 (this looks correct to me):

@article{Datseris2019,
  doi = {10.21105/joss.01166},
  url = {https://doi.org/10.21105/joss.01166},
  year  = {2019},
  month = {mar},
  publisher = {The Open Journal},
  volume = {4},
  number = {35},
  pages = {1166},
  author = {George Datseris and Joel Hobson},
  title = {{MIDI}.jl: Simple and intuitive handling of {MIDI} data.},
  journal = {Journal of Open Source Software}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.