[PRE REVIEW]: MIDI.jl: Intuitive handling of MIDI data made for musicians

[whedon]

Submitting author: @Datseris (George Datserus)
Repository: https://github.com/JuliaMusic/MIDI.jl
Version: v1.0.0
Editor: @Kevin-Mattheus-Moerman
Reviewers: @ssfrr, @jfsantos

Author instructions

Thanks for submitting your paper to JOSS @Datseris. The JOSS editor (shown at the top of this issue) will work with you on this issue to find a reviewer for your submission before creating the main review issue.

@Datseris if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission.

Editor instructions

The JOSS submission bot @whedon is here to help you find and assign reviewers and start the main review. To find out what @whedon can do for you type:

@whedon commands

[whedon]

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

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

@whedon commands

What happens now?

This submission is currently in a pre-review state which means we are waiting for an editor to be assigned and for them to find some reviewers for your submission. This may take anything between a few hours to a couple of weeks. Thanks for your patience 😸

You can help the editor by looking at this list of potential reviewers to identify individuals who might be able to review your submission (please start at the bottom of the list). Also, feel free to suggest individuals who are not on this list by mentioning their GitHub handles here.

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

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

% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed

0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
100 16 0 16 0 0 173 0 --:--:-- --:--:-- --:--:-- 173
Error reading bibliography ./paper.bib (line 19, column 1):
unexpected end of input
expecting space, ",", white space or "}"
Error running filter pandoc-citeproc:
Filter returned error status 1
Looks like we failed to compile the PDF

[Datseris]

I'd like to suggest the following reviewers: @dpsanders

[Datseris]

@whedon commands

[whedon]

Here are some things you can ask me to do:

# List Whedon's capabilities
@whedon commands

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

# Compile the paper
@whedon generate pdf

[Datseris]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[Kevin-Mattheus-Moerman]

@whedon assign @Kevin-Mattheus-Moerman as editor

[whedon]

OK, the editor is @Kevin-Mattheus-Moerman

[Kevin-Mattheus-Moerman]

@ssfrr would you be interested in reviewing this work?

[Kevin-Mattheus-Moerman]

@Datseris thanks for this submission. I'll start looking for reviewers, and will look to see if your submission passes all the preliminary checks. Please let me know if you know of any suitable reviewers. Thanks.

[ssfrr]

Yes, I'm happy to review.

[Kevin-Mattheus-Moerman]

@whedon add @ssfrr as reviewer

[whedon]

OK, @ssfrr is now a reviewer

[Kevin-Mattheus-Moerman]

@Datseris Please consult the author guidelines carefully to make sure your submission conforms to our standards. You can also check out the reviewer guidelines to get an idea off what the reviewers will look for.

Can you work on the following:

• Please expand your readme
  Templates:
  https://gist.github.com/PurpleBooth/109311bb0361f32d87a2
  https://github.com/dbader/readme-template

• Please add contributing guidelines. You can do so by adding a CONTRIBUTING.md file.
  Guides:
  https://help.github.com/articles/setting-guidelines-for-repository-contributors/
  Example:
  https://github.com/gibbonCode/GIBBON/blob/master/CONTRIBUTING.md

• Also consider adding a Code of Conduct document e.g. in the form of a COC.md file.
  Base one on this template: https://www.contributor-covenant.org/
  👉 Make sure to add an email address where it says [INSERT EMAIL ADDRESS]

• Link to the CONTRIBUTING and COC files in the readme.

• I recommend renaming the LICENSE.md file to a LICENSE file and to remove the line The MIDI.jl package is licensed under the MIT "Expat" License.
  👉 Suggestion remove the > symbols from the license text for each line. Perhaps this is why Github does not parse the license file and render the license on your front page, e.g.
  

[Kevin-Mattheus-Moerman]

@ssfrr this is a pre-review issue. Once we have sufficient reviewers I'll open up the former review issue to start the actual review process. Thanks again for your willingness to review this work.

[Datseris]

@Kevin-Mattheus-Moerman thank you for accepting to be the assigned editor. I have made all the changes that you requested, please tick them if you agree with the current master branch.

---

@ssfrr thank you very much for accepting to be a reviewer.

[Kevin-Mattheus-Moerman]

Thanks @Datseris I've updated the comment above.

[Kevin-Mattheus-Moerman]

@Datseris can you work on your paper style and content. Please refer to the JOSS author guidelines.

• One of the requirements for JOSS is that the paper should have a clear research application. Can you please expand on this in the paper? What scientific/research work does this software target? Currently the paper boasts "made for musicians" and "not computer scientists or engineers". Perhaps rephrase those parts. It may be that the intuitive/clear way in which your work handles MIDI files is very useful in research. Can you cite research to which this work would apply?
• "This is very handful,..." should probably be "This is very handy,..." or consider rephrasing to "This is very convenient,...".
• "like e.g." is double, choose e.g., like, or for example.

Let me know if I can help or if you have questions.

[Datseris]

Thank you for your comments @Kevin-Mattheus-Moerman . I have done everything you suggested besides your first point on research applications.

I want to quickly state that this "boasting" that you mention did not come from myself. Rather, users of MIDI.jl contacted me to tell how much easier this has made their work and how it is so much easier to use than other MIDI packages. I now realize that such a fact can only be understood by someone that has worked with MIDI data and has used MIDI.jl. Therefore I will fully rephrase these parts of the paper.

As far as research applications are concerned, the package has plentiful. In fact we just submitted a scientific paper for review in a well respected journal. I hope we have it soon on arXiv so I can cite it. (In fact this is the reason I am submitting this paper, so I can cite it in the main paper)

Even if we don't have the paper on arXiv on time, there are plenty of examples I can show that MIDI.jl can be used in scientific research. I will add a corresponding paragraph as soon as possible.

[Kevin-Mattheus-Moerman]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[Kevin-Mattheus-Moerman]

@Datseris Great. Looking forward to seeing the section on applications to research. In the mean time, please do let me know if you have any other reviewers in mind. Thanks.

[Kevin-Mattheus-Moerman]

@jfsantos would you be interested in reviewing this submission for the Journal of Open Source Software (JOSS). The review process is focused on evaluating the software and a short paper (here is an example review process where you see a checkbox list guiding reviewers through the process). Let me know if you are interested or if you have questions.

[Datseris]

@Kevin-Mattheus-Moerman I have reworked my manuscript and I believe that it satisfies the author guidelines of JOSS and provides a clear scientific application and further use.

[Kevin-Mattheus-Moerman]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

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

% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed

0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
100 16 0 16 0 0 203 0 --:--:-- --:--:-- --:--:-- 205
Error producing PDF.
! Misplaced alignment tab character &.
...is et al., (2019). MIDI.jl: Simple &
intuitive handling of MID...
l.319

Looks like we failed to compile the PDF

[Datseris]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

👉 Check article proof 📄 👈

[Datseris]

Hm, all the references are okay, the only problem is the figure: seems misaligned.

[jfsantos]

I would be glad to review it, as long as that the deadline is not too tight.

[Kevin-Mattheus-Moerman]

@jfsantos great thanks. We can be flexible and do not have a formal deadline.

[Kevin-Mattheus-Moerman]

@whedon add @jfsantos as reviewer

[whedon]

OK, @jfsantos is now a reviewer

[Kevin-Mattheus-Moerman]

@whedon start review

[whedon]

OK, I've started the review over in #1166. Feel free to close this issue now!