-
-
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]: HyperNetX: A Python package for modeling complex network data as hypergraphs #6016
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 |
|
@szhorvat, @IvanIsCoding, and @drj11 - Thanks for agreeing to review this submission. As you can see above, you each should use the command 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, reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention We aim for reviews to be completed within about 4 weeks. Please let me know if either of you require some more time. We can also use editorialbot (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 (@danielskatz) if you have any questions/concerns. |
@editorialbot add @drj11 as reviewer |
@drj11 added to the reviewers list! |
Review checklist for @drj11Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @szhorvatConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @IvanIsCodingConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
I have reviewed the software package and preliminarily I believe it would be a great addition to the papers published at the Journal. SoftwareWith regards to the software, I do not have objections. I believe HyperNetX is a significant scholarly contribution and that it is as mature as if not more mature than other packages published in this journal. From a Software Engineering point of view, I also found the that the test suite of the package meets the standards for publication. I was able to install the software and run the tests without issues. I was also able to generate a code coverage report. There are some warnings when running the tests and the coverage for the Drawing module is on the lower side. But overall the software is tested and Continuous Integration is in place to detect regressions, which is nice. DocumentationFor the documentation I focused more on the provided Jupyter Notebooks and A Gentle Introduction to Hypergraph Mathematics provided in the docs. There are also documentations for every function and class, but I admit I haven't scrutinized each method and looked at the greater picture. As a reviewer with a greater emphasis on graphs than hypegraphs, I found that the "gentle" introduction answered most of the questions for the statement of need and defined the terminology for the package. The Jupyter Notebooks available in Colab were also a pleasant surprise. I think they exemplify how to use the package and highlight the visualization features that come with HyperNetX. PaperThis is the only section where I think there is feedback to give to the authors from my side. Namely:
|
👋 @brendapraggastis - while two reviews are currently in progress, you could respond to (or act on) @IvanIsCoding's comments and issue during this time. |
Thanks @IvanIsCoding and @danielskatz . We are addressing your comments and should be able to push paper changes in the next week or so. |
Sorry about the long absence. If all goes according to plan I hope to finish the review by Dec 14. |
@IvanIsCoding Thanks for the detailed review. I've incorporated your suggesttions in the paper in https://github.com/pnnl/HyperNetX/tree/paper/HNX_Paper. |
@editorialbot generate pdf @brendapraggastis - you could issue this command too, if you make further changes. I'll also check the references again next. Commands need to be the first thing in a comment |
@editorialbot check references |
|
|
@brendapraggastis - if an author has an ORCID, please enter it. If not, please remove the line about it. |
@editorialbot generate pdf |
Software has been stored on Zenodo at https://zenodo.org/records/10790797 DOI: 10.5281/zenodo.10790797 |
@editorialbot set 10.5281/zenodo.10790797 as archive |
Done! archive is now 10.5281/zenodo.10790797 |
@editorialbot recommend-accept |
|
|
👋 @openjournals/csism-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#5099, then you can now move forward with accepting the submission by compiling again with the command |
@brendapraggastis, @bonicim - sorry, but I see two small changes needed in the paper that were in my PR but didn't make it into the changes you made. Please add a space in this line
so that it becomes
And similarly, in
so that it becomes
|
@editorialbot generate pdf |
@danielskatz New DOI: 10.5281/zenodo.10795225 |
Thanks @bonicim - we actually don't need the paper in the archive, so you didn't need to create a new archive or tag, just to update the .md file. However, I didn't say this clearly. In any case, I'll check again now. |
@editorialbot set 10.5281/zenodo.10795225 as archive |
Done! archive is now 10.5281/zenodo.10795225 |
@editorialbot recommend-accept |
|
|
👋 @openjournals/csism-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#5112, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
Congratulations to @brendapraggastis (Brenda Praggastis) and @bonicim and co-authors on your publication!! And thanks to @szhorvat, @IvanIsCoding, and @drj11 for reviewing! |
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... |
Thanks for getting us through the process! @danielskatz @szhorvat @drj11 @IvanIsCoding and of course Mark @bonicim . |
Submitting author: @brendapraggastis (Brenda Praggastis)
Repository: https://github.com/pnnl/HyperNetX
Branch with paper.md (empty if default branch): paper
Version: v2.2.0p
Editor: @danielskatz
Reviewers: @szhorvat, @IvanIsCoding, @drj11
Archive: 10.5281/zenodo.10795225
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
@szhorvat & @IvanIsCoding, 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 @danielskatz 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 @szhorvat
📝 Checklist for @drj11
📝 Checklist for @IvanIsCoding
The text was updated successfully, but these errors were encountered: