Skip to content
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]: serp: An R package for smoothing in ordinal regression #3705

Closed
40 tasks done
whedon opened this issue Sep 9, 2021 · 51 comments
Closed
40 tasks done

[REVIEW]: serp: An R package for smoothing in ordinal regression #3705

whedon opened this issue Sep 9, 2021 · 51 comments
Assignees
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX

Comments

@whedon
Copy link

whedon commented Sep 9, 2021

Submitting author: @ejikeugba (Ejike Ugba)
Repository: https://github.com/ejikeugba/serp
Version: v0.2.2
Editor: @Bisaloo
Reviewer: @bernardsilenou, @wesleyburr
Archive: 10.5281/zenodo.5596864

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/6ebd3b75ea792be908f0dadebd7cf81c"><img src="https://joss.theoj.org/papers/6ebd3b75ea792be908f0dadebd7cf81c/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/6ebd3b75ea792be908f0dadebd7cf81c/status.svg)](https://joss.theoj.org/papers/6ebd3b75ea792be908f0dadebd7cf81c)

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

@bernardsilenou & @wesleyburr, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @Bisaloo 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

Review checklist for @bernardsilenou

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@ejikeugba) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @wesleyburr

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@ejikeugba) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?
@whedon
Copy link
Author

whedon commented Sep 9, 2021

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @bernardsilenou, @wesleyburr it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

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

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Sep 9, 2021

Wordcount for paper.md is 1543

@whedon
Copy link
Author

whedon commented Sep 9, 2021

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.03 s (955.2 files/s, 131750.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               15            127            664           1838
Markdown                         4             92              0            258
TeX                              1             27              0            220
YAML                             5             45              9            201
Rmd                              1             26             72              7
-------------------------------------------------------------------------------
SUM:                            26            317            745           2524
-------------------------------------------------------------------------------


Statistical information for the repository 'edb7629ff7ea7e2f21e78c6c' was
gathered on 2021/09/09.
No commited files with the specified extensions were found.

@whedon
Copy link
Author

whedon commented Sep 9, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1002/9780470594001 is OK
- doi.org/10.4137/CIN.S20806 is OK
- 10.1080/00401706.2000.10485983 is OK
- 10.1002/wics.1296 is OK
- 10.2307/2347760 is OK
- 10.1177/1471082X16642560 is OK
- 10.3390/stats4030037 is OK
- 10.1080/01621459.2016.1180986 is OK
- 10.1111/j.1467-9868.2005.00503.x is OK

MISSING DOIs

- 10.2307/2288515 may be a valid DOI for title: Advanced Econometrics: A Bridge to the Literature
- 10.1007/bf02985802 may be a valid DOI for title: The Elements of Statistical Learning: Data Mining, Inference and Prediction
- 10.18637/jss.v099.i06 may be a valid DOI for title: Regularized ordinal regression and the ordinalNet R package

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Sep 9, 2021

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@Bisaloo
Copy link
Member

Bisaloo commented Sep 20, 2021

👋👋 @bernardsilenou @wesleyburr, as agreed this is a friendly reminder about your review for the serp R package and the associated paper.

This is the review thread for the paper. All of our communications will happen here from now on.

Both reviewers have checklists at the top of this thread with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#3705 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. We can also use Whedon (our bot) to set automatic reminders if you know you'll be away for a known period of time.

Please feel free to ping me (@Bisaloo) if you have any questions/concerns.

@Bisaloo
Copy link
Member

Bisaloo commented Sep 22, 2021

@whedon re-invite @bernardsilenou as reviewer

@whedon
Copy link
Author

whedon commented Sep 22, 2021

OK, the reviewer has been re-invited.

@bernardsilenou please accept the invite by clicking this link: https://github.com/openjournals/joss-reviews/invitations

@bernardsilenou
Copy link

bernardsilenou commented Sep 22, 2021 via email

@whedon
Copy link
Author

whedon commented Sep 23, 2021

👋 @bernardsilenou, please update us on how your review is going (this is an automated reminder).

@whedon
Copy link
Author

whedon commented Sep 23, 2021

👋 @wesleyburr, please update us on how your review is going (this is an automated reminder).

@wesleyburr
Copy link

The codebase is very clean (as it would have to be, to pass CRAN checks). Nothing to edit in the package or documentation itself, I think, although some modifications should be made to the Readme / community guidelines for the GitHub face and the pkgdown, DOIs added to the references in the paper itself. Three issues opened for the paper author to deal with, then I'm ready to sign off.

@danielskatz
Copy link

@wesleyburr - please manually create issues in the source repository (https://github.com/ejikeugba/serp) - not here, not using the github convert-to-issue "feature" - this feature doesn't work correctly with JOSS, as the issues are created in the wrong place. (The issues you have created using that feature have been automatically closed, as the JOSS workflow doesn't support them correctly). Also, if you can mention openjournals/joss-reviews#3705 in those issue you create in https://github.com/ejikeugba/serp, they will appear here and then be tracked from this issue.

@wesleyburr
Copy link

@danielskatz - done!

@ejikeugba
Copy link

Dear @wesleyburr, thanks for the comments and the suggested issues. I will let you know once I have them all addressed.

@ejikeugba
Copy link

@wesleyburr, thanks once again for the helpful suggestions, I now have them all addressed. Let me know if there are more things to fix.

@ejikeugba
Copy link

@Bisaloo, done!

@ejikeugba
Copy link

@bernardsilenou, thank you for the helpful suggestions. The issues mentioned have all been addressed.

Perhaps, it would make sense to re-generate the pdf once again, since changes are made in it. Thanks!

@Bisaloo
Copy link
Member

Bisaloo commented Oct 25, 2021

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Oct 25, 2021

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@Bisaloo
Copy link
Member

Bisaloo commented Oct 25, 2021

@whedon check references

@whedon
Copy link
Author

whedon commented Oct 25, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1002/9780470594001 is OK
- 10.1111/j.2517-6161.1980.tb01109.x is OK
- 10.2307/2682804 is OK
- 10.1007/978-0-387-84858-7 is OK
- 10.1007/978-3-642-20192-9 is OK
- 10.3390/stats4030037 is OK
- 10.1177/1471082X16642560 is OK
- 10.1111/j.2517-6161.1996.tb02095.x is OK
- 10.18637/jss.v032.i10 is OK
- 10.1111/j.2517-6161.1996.tb02080.x is OK
- 10.1080/00401706.2000.10485983 is OK
- 10.1111/j.1467-9868.2005.00503.x is OK
- 10.4137/CIN.S20806 is OK
- 10.18637/jss.v099.i06 is OK
- 10.1080/01621459.2016.1180986 is OK
- 10.1002/bimj.4710310703 is OK
- 10.1002/wics.1296 is OK
- 10.2307/2347760 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@bernardsilenou
Copy link

@Bisaloo
Responding to #3705 (comment)

  • I did not find any error related to how the method has been implemented. I also approved the package.

@Bisaloo
Copy link
Member

Bisaloo commented Oct 25, 2021

@ejikeugba, once ejikeugba/serp#11 is merged, could be please create a new version (edit the DESCRIPTION file and tag the new version on GitHub) and archive the package on, e.g., zenodo?

@ejikeugba
Copy link

Thanks, @Bisaloo, @wesleyburr, @bernardsilenou for the positive reviews.

The new release version is 0.2.2 and the doi 10.5281/zenodo.5596864

@Bisaloo
Copy link
Member

Bisaloo commented Oct 26, 2021

@whedon set v0.2.2 as version

@whedon
Copy link
Author

whedon commented Oct 26, 2021

OK. v0.2.2 is the version.

@Bisaloo
Copy link
Member

Bisaloo commented Oct 26, 2021

@whedon set 10.5281/zenodo.5596864 as archive

@whedon
Copy link
Author

whedon commented Oct 26, 2021

OK. 10.5281/zenodo.5596864 is the archive.

@Bisaloo
Copy link
Member

Bisaloo commented Oct 26, 2021

I'm happy to accept this submission. Congratulations @ejikeugba! 🎉

And thank you again so much @bernardsilenou and @wesleyburr for your valuable help and your time 🙏!

@Bisaloo
Copy link
Member

Bisaloo commented Oct 26, 2021

@whedon recommend-accept

@whedon
Copy link
Author

whedon commented Oct 26, 2021

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Oct 26, 2021
@whedon
Copy link
Author

whedon commented Oct 26, 2021

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#2710

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2710, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Oct 26, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1002/9780470594001 is OK
- 10.1111/j.2517-6161.1980.tb01109.x is OK
- 10.2307/2682804 is OK
- 10.1007/978-0-387-84858-7 is OK
- 10.1007/978-3-642-20192-9 is OK
- 10.3390/stats4030037 is OK
- 10.1177/1471082X16642560 is OK
- 10.1111/j.2517-6161.1996.tb02095.x is OK
- 10.18637/jss.v032.i10 is OK
- 10.1111/j.2517-6161.1996.tb02080.x is OK
- 10.1080/00401706.2000.10485983 is OK
- 10.1111/j.1467-9868.2005.00503.x is OK
- 10.4137/CIN.S20806 is OK
- 10.18637/jss.v099.i06 is OK
- 10.1080/01621459.2016.1180986 is OK
- 10.1002/bimj.4710310703 is OK
- 10.1002/wics.1296 is OK
- 10.2307/2347760 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@ejikeugba
Copy link

@Bisaloo, thank you very much.
I have gone through the final proof once again, everything looks fine to me.

Thanks once again @wesleyburr and @bernardsilenou for making out time to work on this submission.

@kthyng
Copy link

kthyng commented Oct 27, 2021

@ejikeugba Everything looks ready to go! Nice work team!

@kthyng
Copy link

kthyng commented Oct 27, 2021

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Oct 27, 2021

Doing it live! Attempting automated processing of paper acceptance...

@whedon whedon added accepted published Papers published in JOSS labels Oct 27, 2021
@whedon
Copy link
Author

whedon commented Oct 27, 2021

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@whedon
Copy link
Author

whedon commented Oct 27, 2021

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.03705 joss-papers#2714
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03705
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@kthyng
Copy link

kthyng commented Oct 27, 2021

Congrats on your new publication @ejikeugba!! Many thanks to editor @Bisaloo and reviewers @bernardsilenou and @wesleyburr for your hard work, time, and expertise!!

@kthyng kthyng closed this as completed Oct 27, 2021
@whedon
Copy link
Author

whedon commented Oct 27, 2021

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03705/status.svg)](https://doi.org/10.21105/joss.03705)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.03705">
  <img src="https://joss.theoj.org/papers/10.21105/joss.03705/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.03705/status.svg
   :target: https://doi.org/10.21105/joss.03705

This is how it will look in your documentation:

DOI

We need your help!

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX
Projects
None yet
Development

No branches or pull requests

7 participants