-
-
Notifications
You must be signed in to change notification settings - Fork 38
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]: JeFaPaTo - A joint toolbox for blinking analysis and facial features extraction #6425
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 |
|
Review checklist for @mpribConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @draabeConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper (cf. cvjena/JeFaPaTo#10 )
|
@samhforbes thanks for editing. It would be great if you could check in about once a week to help spur on this review. |
I've opened up a couple issues and it's my understanding the primary author is traveling out of country at the moment so things are in a bit of stasis. I had trouble confirming functionality of the package when installing the binaries on Ubuntu, so I'm going to attempt to run just from cloning the repo and see how that goes. I should be able to complete comments on Documentation and Software Paper in the coming week. Regards, Mac |
@Kevin-Mattheus-Moerman on it this week |
Yes, indeed ^^ I am now fully back in the office after dealing with German bureaucracy. I have already started to investigate some of the unwanted software behavior and shipped some fixes in the I already really highly appreciate the work put into it :) |
@editorialbot generate pdf |
Hi @Timozen & @samhforbes , I've completed the first round of review and would like to give a brief general summary. First, congrats to the author's for creating this great piece of software! It is feature-rich and has a lean and easy-to-use GUI. Installation works fine, and it runs smoothly on my mid-end machine. The paper is well-written but could be improved slightly (cvjena/JeFaPaTo#10). However, I do have one major concern regarding package documentation. If I haven't missed anything, there seems to be no standalone documentation, such as a hosted documentation, a user manual or else. Instead, the documentation is somewhat scattered between the repository's I'd personally suggest to create a standalone documentation for the package (leaving the choice of format to the authors), including a thorough functionality documentation, feature/output description and usage examples/walkthroughs. I think this will greatly benefit the usability and especially help the non-technical target audience adapting it into their workflows (speaking of experience here). A lot of material is already available, so this should leave the authors not starting from scratch, and I'm happy to provide more detailed feedback in an issue if that helps. However, I'd politely ask you @samhforbes to weigh in on this matter. I'm a bit unsure if such a standalone documentation is required by JOSS standards (or if requirements can also be satisfied from within the software paper and Thanks, @draabe |
Thank you once again for this valuable feedback! We included the input of @draabe, and a new version is available at the main branch. I agree that external documentation would be helpful, and we and some medical project partners have planned it. |
Hi @Timozen and @draabe thanks for this discussion. |
Hi @Timozen & @samhforbes , thanks for the quick replies - both made sense to me and clarified the matter. In terms of community standards, I believe that project structure (packaging, installation, testing) together with repository documentation (readme, installation, contributing) are largely in place to ensure best practices and help users/contributors to navigate around the project. In terms of usage documentation, I agree with @samhforbes in that some sort of vignette/documentation/manual should accompany the package. @Timozen, since you are planning the latter anyway, maybe an option would be to start with a minimal version of such a documentation as part of this review, which you could then extend in the future? If you want, I can also share my UX and some of the points I found a little more difficult to understand in a separate issue. |
To both of you, @samhforbes and @draabe, thanks a lot! I will leverage the GitHub wiki function to create a small documentation tutorial as a first point of action. Continuous updates will be done there :) I will create the content stepwise to include a simple workflow other people can follow and use. I would also appreciate it if you @draabe could share your UX in this issue: cvjena/JeFaPaTo#12 Once the tutorial documentation is satisfactory, I will let you know again! |
Thank you to @draabe for the suggestions regarding consolidated documentation. I also found myself hunting around for information in different places and think a central guide would be a useful addition. I'm holding off for now and will check back in when @Timozen notes that the tutorial is ready for review. One note for @Timozen because it may relate to the tutorial or at least the installation instructions. I'm still on Windows 10 and found everything worked with ease just cloning, creating a standard |
Hey everyone, @samhforbes, @draabe and @mprib, I took all your recommendations to heart and created a more user-friendly documentary with the wiki functionality from GitHub. I added the following things there:
Also, minor changes to the software itself:
I pushed these changes to the main branch of the repository and I would appreciate if you can check the wiki itself. Currently, the only thing remaining is building the precompiled binaries for Windows and the different MacOS versions. |
I have created the binary version of |
Done! archive is now 10.5281/zenodo.11085954 |
@editorialbot check references |
|
@Timozen the paper is looking really good. There's a couple of DOIs that have been flagged as missing, so if you could fix that, that would be great. |
@samhforbes I updated the missing dois where possible!
|
@editorialbot check references |
|
@editorialbot recommend-accept |
|
|
👋 @openjournals/bcm-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#5299, then you can now move forward with accepting the submission by compiling again with the command |
@Timozen as AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I have checked this review, your repository, the archive link, and the paper. Most seems in order, however the below are some points that require your attention:
|
Dear @Kevin-Mattheus-Moerman, thank you for pointing out these mistakes by me. Best, Tim |
@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... |
@Kevin-Mattheus-Moerman, thank you very much! Everything looks fine so far; only the PDF is not yet visible when visiting the corresponding JOSS page. I just assume that the server needs some minutes to process everything. |
@Timozen looks like the DOI is resolving now (you may need to refresh your page). |
@Timozen congratulations on this JOSS publication! @samhforbes thanks for editing! |
🎉🎉🎉 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:
|
Congrats, @Timozen ! @Kevin-Mattheus-Moerman , @samhforbes , @mprib thank you for your help, this was a great reviewing experience! |
Thanks again @samhforbes, @draabe and @mprib! Without your dedicated work JOSS would not be what is! |
Submitting author: @Timozen (Tim Büchner)
Repository: https://github.com/cvjena/JeFaPaTo
Branch with paper.md (empty if default branch):
Version: v1.1.0
Editor: @samhforbes
Reviewers: @mprib, @draabe
Archive: 10.5281/zenodo.11085954
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
@mprib & @draabe, 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 @samhforbes 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 @mprib
📝 Checklist for @draabe
The text was updated successfully, but these errors were encountered: