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]: stimupy: A Python stimulus creation package for vision science #5321
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 |
|
Hi @alexander-pastukhov and @JonathanReardon 👋 Thank you again for agreeing to review this submission ! The review will take place in this issue, and you can generate your individual reviewer checklists by asking editorialbot directly with In working through the checklist, you're likely to have specific feedback on stimupy. Whenever possible, please open relevant issues on the linked software repository (and cross-link them with this issue) rather than discussing them here. This helps to make sure that feedback is translated into actionable items to improve the software ! If you aren't sure how to get started, please see the Reviewing for JOSS guide -- and, of course, feel free to ping me with any questions ! |
Review checklist for @alexander-pastukhovConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @JonathanReardonConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@emdupre I am first-time reviewer for JOSS, so I am not sure how do I proceed. I like the concept behind the package and I can see how it would be widely used by the visual community (I probably would with a caveat that virtually all my stimuli are dynamic and the package appears to only be able to handle the static ones). Paper-wise, I have only couple of minor issues (but I am not sure where and how I post them). But... Either the docs, or the package (or both) are half-backed. There is a limited number of examples in "Getting started" and a lot of them simply do not work (and errors are fairly variable, implying that this is not the same issue such as a single missing dependence). An important section of documentation In short, is it a good package that will be useful for the community - yes, should it be accepted by JOSS once it is more polished and ready - absolutely, is it ready (at least the docs) - no. |
@alexander-pastukhov I am having trouble importing the package after install, though I have left an issue about this. From what I can see so far, the developers have submitted this for publication too early. I'm happy to continue with the review (assuming I can eventually install it) but I think it's going to take too much work to address all that is missing during this review cycle. |
Thank you both for your quick (!) and considered feedback, @alexander-pastukhov and @JonathanReardon ! To cross-link the currently raised issues:
I am able to install and import the package locally, and I can replicate the The JOSS reviewing guidelines note that :
If you believe that there is sufficient documentation for you to understand the core functionality of the software and assess how it meets the functionality claims described in the JOSS paper, then I think we can proceed with the review. Please let me know. @LynnSchmittwilken, please feel free to start addressing the current issues as raised by the reviewers ! You do not need to wait until a specific point to engage in this process. |
Thanks a lot for the considerate and honest review! We have started working on the issues that you raised, particularly with respect to the documentation. |
👋 Hi everyone, 🎉 Happy Monday ! I just wanted to follow-up @alexander-pastukhov and @JonathanReardon and confirm if you feel comfortable proceeding with the review. Please let me know, and thank you again for your thoughtful comments to date ! |
I also wanted to cross-link another, more recently raised issue from this review : computational-psychology/stimupy#75 |
Hello all! I'm one of the authors and maintainers of stimupy! 👋 Thanks for the very helpful feedback so far. Updates from our side:
I hope this gives some perspective on how we're taking in the review from our side. If there are any questions or concerns, we're very happy to address those. Thanks again for the constructive and critical review, since we really want stimupy to become a great solution to common problems in vision science, for both experts and novices, all feedback is hugely valuable to us! |
👋 Happy Tuesday, everyone, and thank you for these updates, @JorisVincent ! @alexander-pastukhov and @JonathanReardon , please let me know if these edits address your initial concerns. And thank you again for your time and expertise ! |
Apologies for the delay @emdupre. Yes, it looks like there's been a lot of work on the project since I last checked, which is brilliant. Concerns are most certainly being addressed. Thanks @LynnSchmittwilken & @JorisVincent ! |
@emdupre Sorry, somehow lost the track of time. The authors addressed my initial concerns but I've raised two more issues regarding documentation. I feel that having topic guides on 1) how to use stimuli generated by the package in other software, and 2) how to create and deposit your own stimulus for later replication, are critical as they relate to the core use of the package (create and use stimulus for my research, then tell others how to replicate it). |
Thank you for the update, @alexander-pastukhov ! I'm cross-linking the two newly raised issues for clarity: |
Hi all! 👋 @LynnSchmittwilken and I have been hard at work addressing the remaining issues, primarily related to documentation. Those are now merged in, and the latest documentation is live! Please let us know if there is anything else that we should address! |
Thank you for confirming, @JorisVincent ! It's great to see these issues addressed. @JonathanReardon and @alexander-pastukhov , could you please revisit your reviewer checklists and confirm if you feel that If you have any remaining concerns, of course, please let me know ! |
@emdupre The authors did a brilliant job, as now the already excellent package is very thoroughly documented, Nothing else on my side. |
@emdupre Done my checklist as well, I think it is ready for publication. |
@emdupre Hm, this seems to be an issue on OSF's side. The OSF registration is marked as public, but not showing up as such (yet). We have contacted OSF about this, and hope to hear back from them soon. |
@editorialbot set 10.17605/OSF.IO/Z439V as archive |
Done! archive is now 10.17605/OSF.IO/Z439V |
@editorialbot generate pdf |
@editorialbot check references |
|
Thank you, @JorisVincent ! Confirming that I am now able to access the archive and have confirmed its metadata. |
I'm now happy to recommend stimupy for publication 🚀 Congratulations @LynnSchmittwilken, and thank you to @alexander-pastukhov and @JonathanReardon for your time and expertise in reviewing this submission ! |
@editorialbot recommend-accept |
|
|
👋 @openjournals/sbcs-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#4294, then you can now move forward with accepting the submission by compiling again with the command |
Dear @emdupre , We also want to use this chance to thank you as well as @alexander-pastukhov and @JonathanReardon for the pleasant and very constructive review and all your feedback! |
@editorialbot recommend-accept |
|
|
👋 @openjournals/sbcs-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#4304, 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. |
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🐘🐘🐘 👉 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... |
Congratulations to @LynnSchmittwilken! 🍾 And a big thanks to @emdupre and the reviewers: @alexander-pastukhov, @JonathanReardon! 👏 |
🎉🎉🎉 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:
|
Submitting author: @LynnSchmittwilken (Lynn Schmittwilken)
Repository: https://github.com/computational-psychology/stimupy
Branch with paper.md (empty if default branch):
Version: v1.0.0
Editor: @emdupre
Reviewers: @alexander-pastukhov, @JonathanReardon
Archive: 10.17605/OSF.IO/Z439V
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
@alexander-pastukhov & @JonathanReardon, 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 @emdupre 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 @alexander-pastukhov
📝 Checklist for @JonathanReardon
The text was updated successfully, but these errors were encountered: