-
-
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]: statConfR: An R Package for Static Models of Decision Confidence and Metacognition #6966
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:
|
Software report:
Commit count by author:
|
Paper file info: 📄 Wordcount for ✅ The paper includes a |
License info: 🟡 License found: |
|
Hi @haoxue-fan, @christinamaher this is our review thread. |
Hi @haoxue-fan, @christinamaher I just thought I'd check in and see how things were coming along. Please ping me if there's anything you need. |
Hi @samhforbes ! Thanks for checking in, apologies for the delay. I am returning today from conference travel. I aim to complete this by the end of the week. |
Review checklist for @haoxue-fanConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @christinamaherConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hi @samhforbes ! I believe I've gone through the relevant points in the checklist above. The issues (related to points I left unchecked above) are as follows - Documentation - Functionality Documentation: The code would benefit significantly from improved documentation. Software Paper - Summary: The paper lacks a high-level summary of the package’s primary use-case. Including this summary would help readers understand the main objectives and applications of the package. |
Great, thanks @christinamaher |
Thanks for the opportunity to review the package and sorry for the delayed response! I first want to applaud for the authors @ManuelRausch for their effort putting together this package - it is super useful for researchers in relevant fields both in terms of encouraging them to try out different models as well as lower the coding barrier. I was able to load the R package and run the code as stated in README without difficulty. However, I have a couple of comments listed below most related to the writing and the documentation aspects of the package that I think worth improving:
|
Thank you very much @christinamaher and @haoxue-fan for your feedback. I am sorry that I have not been responsive; I was distracted. I will work on a revision as soon as I can. |
Oh how lovely @ManuelRausch. Enjoy this wonderful period! |
Hi @ManuelRausch hope things are well with you and the little one. not chasing here at all, but thought I'd check in and see when you might be able to look at this. |
I am back to doing scientific work and I'll be working on a revision. |
Hi @ManuelRausch that's great - let me know if I can answer any queries in the meantime |
Hi @ManuelRausch Just checking in to see how things are here? |
I'm so sorry for the long delay. We have now finished a revision of the package. |
@haoxue-fan. Thank you very much! Your feedback is much appreciated. |
According to the JOSS website, JOSS papers are expected to have metadata, a statement of need, Summary, Acknowledgements, and References sections. Software documentation should not be in the paper and instead should be outlined in the software documentation (https://joss.readthedocs.io/en/latest/paper.html). Although I saw examples papers where this rule did not seem to be strictly enforced, we feel that it is better to keep paper and documentation separate: Although I am not planning to change the user interface, sooner or later, there will be updates to the package. The software documentation can be more promptly updated than the paper. However, we agree that a step-by-step walkthrough example in the paper is useful. For this purpose, we have worked out the example in the README file (see section 5). The usage example demonstrates the workflow in which we envision that the functions are used, and what the output of each function means. |
In the new version of the readme, we describe how the documentation can be accessed (section 6). In addition, the readme now includes a mathematical description of each model (section 2). Finally, the revised usage example in the readme describes the inputs and outputs of all function we expected the user to interact with (sections 5.2 – 5.4). |
Hi @haoxue-fan and @christinamaher thank you both for reviewing. Would you mind checking off the checklist please in that case? |
I checked all remaining points - please let me know if anything additional is needed, thanks! |
same here, thanks! |
Thank you both! @ManuelRausch we can now move to the post review part of this. I will create a checklist for each of us to go through |
Post-Review Checklist for Editor and AuthorsAdditional Author Tasks After Review is Complete
Editor Tasks Prior to Acceptance
|
Hi @ManuelRausch any joy with the above tasks? |
I am still working on Latex Compatibility issues for the release on CRAN. |
|
@editorialbot set 0.2.0 as version |
Done! version is now 0.2.0 |
@editorialbot set 10.17605/OSF.IO/EQ3XK as archive |
Done! archive is now 10.17605/OSF.IO/EQ3XK |
@editorialbot check references |
|
@editorialbot generate pdf |
Ah yeah that is normal behaviour until I final volume and DOI etc are assigned! Just had a read and all looks good, except in the references, where for journal articles the article title should be in sentence case (except after a colon), and the journal name should have first letters capitalised. See for example Hellman et al 2024 which is one that needs fixing. |
@editorialbot generate pdf |
Corrected. |
@editorialbot check references |
|
Looks great, well done @ManuelRausch |
@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#6450, then you can now move forward with accepting the submission by compiling again with the command |
Thank you very much! |
Submitting author: @ManuelRausch (Manuel Rausch)
Repository: https://github.com/ManuelRausch/StatConfR
Branch with paper.md (empty if default branch):
Version: 0.2.0
Editor: @samhforbes
Reviewers: @haoxue-fan, @christinamaher
Archive: 10.17605/OSF.IO/EQ3XK
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
@haoxue-fan & @christinamaher, 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 @haoxue-fan
📝 Checklist for @christinamaher
The text was updated successfully, but these errors were encountered: