-
-
Notifications
You must be signed in to change notification settings - Fork 39
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]: SonoUno development: a User Centred Sonification software for data analysis #5819
Comments
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:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Wordcount for |
|
@ceb8, @james-trayford thank you for agreeing to review this submission! Check out the comment above for instructions on how to generate your checklist. We are looking for reviews to be completed ~ the end of September. Don't hesitate to contact me if you have any issues. |
Review checklist for @ceb8Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @james-trayfordConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@ceb8 @james-trayford could we please look at wrapping the review in the next week or so? Let me know if there's anything I can help with. |
@ivastar Yes definitely reasonable I think - I had to defer reviewing until this week due to unforeseen circumstances (hopefully you received my email) |
@james-trayford yes, I did, thank you for the heads up! Just pinging everyone here for visibility of the authors as well. |
@johicasado I enjoyed exploring sonoUno and it's functionality, and think it represents a valuable tool in providing accessible sonification of 1D data (in the pitch-mapping tradition) for research applications. I congratulate the developers on their work and hope that the comments are constructive towards the future development of the code! I think the code works as represented in the submission and there are a few relatively minor things to complete the checklist. I opened a related Issue here: sonoUnoTeam/sonoUno-desktop#11 With some small code suggestions in the PR sonoUnoTeam/sonoUno-desktop#10 My checklist quoted below with some explanations (@ivastar I was unsure if the check means that I have considered that aspect or that aspect has been deemed to already be met by the submission, have assumed the latter)
I noticed that the current MIT license includes some extra text, I've included that in the PR sonoUnoTeam/sonoUno-desktop#10
it would be good to package the SDSS example data with the code - I had problems with the SDSS server while going through instructions which meant I couldn't proceed. If this is included in the sample data, that could make things more convenient
The User guide document could use some proofreading, but is fully comprehensible. Perhaps some more extension on the Octave functionality or pointing to external relevant octave documentation would be helpful.
I think more or less covered, but it might be good to make these three more explicit in e.g. the README
The paper is clear and addresses all of these points in my opinion. One thing I think could be improved is mentioning some other codes that have emerged for sonification (e.g. |
@james-trayford, yes, this assumption is correct: a check means that the submission meets the requirements |
@james-trayford thank you very much for all your comments! I will go through the GitHub Issues shortly, thank you! |
@ceb8 a gentle reminder to complete the review. Thanks! |
@johicasado This is clearly represents substantial effort and is a valuable contribution to the sonification landscape. I have only minor comments which I intersperse with the relevant checklist items below.
I first installed sonoUno from pip, however that version threw an error, so instead I installed from source which worked perfectly well. Perhaps this means a new pip release is in order.
A few things I noticed:
While everything (installation instructions, user manual, github repo) is nicely linked from the sonoUno website, the website is not mentioned in the GitHub repo. I would be good to include that prominently, right at the top of the README file. Similarly after the installation instructions in the README it would be good to have a link to the user manual before diving into the bash mode instructions. Also when the website is mentioned in the user manual itself the URL is not included (or at least in the English version, which was the one I looked at), and should be.
I don't know what this statement means: “In the files to import the first column must have continuous values, it is used as a coordinate dependent axis.” I think it means that the first column needs to be monotonically increasing or decreasing, but it could do with clarification. And if it does mean what I think then either the file(s) that do not conform to this format in the
The user manual provides much of this functionality, but there are a few holes:
In the documentation it indicates that users should communicate any issues to the development team (start of section 2), it would be good to include specific instructions on how.
|
@ceb8 thank you for the detailed review! @johicasado please let me know when you have been able to address the comments. |
@ivastar How will we continue the review process? I have already started with the documentation to implement the recommendations. Do I have to indicate here the updates that solve the recommendations? or do I have to open an issue on GitHub? |
@johicasado you can make all changes to the library, documentation and paper and commit them to the repository. This will allow us to generate a new manuscript here. You don't have to open a new issue. Once the changes are made, please let us know here. The reviewers and I will check the changes. |
@ivastar Thank you very much! I will let you know shortly! |
Following the recommendation of @james-trayford on the JOSS review (openjournals/joss-reviews#5819), I include the SDSS file used during the user manual explanations in the sample_data folder.
Problem detected during the JOSS journal review by @ceb8 on the issue (openjournals/joss-reviews#5819). The data files are corrupted so how and was erased to avoid confusion.
|
@editorialbot generate pdf |
@editorialbot check references |
|
@johicasado can you please update the Zenodo release with the latest version of the paper? Not sure if we need a new tag too. |
@ivastar yes, the new tag is 4.1.1 |
@editorialbot set 4.1.1 as version |
Done! version is now 4.1.1 |
@editorialbot recommend accept |
I'm sorry human, I don't understand that. You can see what commands I support by typing:
|
@editorialbot commands |
Hello @ivastar, here are the things you can ask me to do:
|
@editorialbot recommend-accept |
|
|
👋 @openjournals/aass-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#4941, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
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
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. |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
Many thanks to @ceb8 and @james-trayford for reviewing and to @ivastar for editing! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you!! @johicasado — Your paper is now accepted and published in JOSS! ⚡🚀💥 |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: 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:
|
@dfm Thank you very much! @ivastar @ceb8 @james-trayford I'm grateful for your time and help to make it possible! Regards! |
Submitting author: @johicasado (Johanna Casado)
Repository: https://github.com/sonoUnoTeam/sonoUno-desktop
Branch with paper.md (empty if default branch): master
Version: 4.1.1
Editor: @ivastar
Reviewers: @ceb8, @james-trayford
Archive: 10.5281/zenodo.10303871
Status
Status badge code:
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
@ceb8 & @james-trayford, 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:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @ivastar 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 @ceb8
📝 Checklist for @james-trayford
The text was updated successfully, but these errors were encountered: