-
-
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]: PANINIpy: Package of Algorithms for Nonparametric Inference with Networks in Python #7312
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: |
Review checklist for @gchureConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @ankurankanConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
The package appears well-developed and includes a range of examples, making it accessible. My primary feedback is focused on the paper, which in my opinion can benefit from some refinement to ensure that key points come across more clearly. Specific Feedback: Installation: Currently, the package does not automatically install its dependencies, nor could I locate a requirements file. Running the example code in the documentation led to errors and based on that I had to manually install numpy, pandas, and scipy. I think these dependencies should get installed automatically. Automated Tests: I couldn't find any automated tests for the package’s functionality. If I missed these, could you please point them out? Statement of Need: I think this section can be refined to improve readability and clarity. For example, the last sentences in the first paragraph appear to hint towards the need for non-parametric methods, but this point is not clearly articulated since "non-parametric" isn't mentioned explicitly. Additionally, the next paragraph introduces non-parametric methods, but because the motivation isn't clear in the last paragraph it isn't clear why is it needed. I also think, in the current text, there isn't a clear distinction between the need for non-parametric methods and the need for the software package. Related Software Packages: The arguments here could be clarified to more effectively illustrate the specific advantages of PANINIpy. For instance, in the comparison with Graph-Tool, it’s not fully clear in which cases PANINIpy should be preferred over Graph-Tool. Based on the text, it seems that there is some overlap, but is it just about the ease of use or there are distinct methods. Clarifying these distinctions would help reinforce the contributions of PANINIpy. |
Hi @vissarion, I've made it as far as I can right now in my review. I've opened up issues regarding licensing, documentation, and testing and view those as blocking. Like @ankurankan, I had trouble installing this project due to the lack of clear requirements. Additionally, the package appears to be missing testing writ large, which should be addressed before I continue assessing the functionality claimed in the project. |
Hi, @gchure and @ankurankan thanks for your reviews so far! @baiyueh could you please reply to and address the issues opened by reviewers. |
Hi @ankurankan and @gchure, thank you for your helpful suggestions about the Installation, Automated Tests, Statement of Need and Related Software Packages sections, as well as your time to review the paper. We've addressed the paper-related comments as follows: (1) We've added the CI for auto-testing, which has been discussed here under the section Testing and Continuous Integration. Besides, all dependencies have been tested under the clean test environment and through series of workflow. (2) We've clarified the motivating first paragraph in question by explicitly mentioning the nonparametric requirement that is central to the package, which allows for the avoidance of ad hoc parameter choices and provides robustness to noise that we mention is important. (3) We've edited our discussion of existing methods to focus on the novelty and importance of having a separate PANINIpy package. In particular, we've emphasized that the existing packages only have methods for community detection and/or network reconstruction (two network inference tasks which we do not address with PANINIpy), and that PANINIpy has a wide breadth of different unsupervised inference methods (e.g. hub identification, network population clustering, etc) whose results can be compared on a universal scale (data compression in bits) to find parsimonious summaries of networks from multiple perspectives. We have tried to emphasize in the revision that there is actually little overlap with these other packages in terms of the inference tasks being addressed, which can enhance the justification for the need for the package. (4) We have combined the "Statement of Need" and "Related Software Packages" sections as we feel the argument for the package's novelty and importance can be made more concise this way. But we are happy to separate them if this is desired. Let us know if you have further concerns regarding the software, paper or documentation. Happy to help. |
Hi @vissarion, I closed my last remaining issue with PANINIpy and have checked the last box on my review checklist. I think it's ready to go! Thanks @baiyueh for the rapid responses on my issues, and sorry this review took longer than I anticipated. |
@editorialbot generate pdf |
@baiyueh Thanks for the changes, I think the paper reads much better now. A very minor suggestion about the current modules section: The citations are currently within brackets which look a bit weird in sentences. I don't know if there is a way to add citations without brackets? Else, you could potentially rewrite these sentences in a bit more compact form like: "Methods (A. Kirkley, 2024b) for identifying MDL-optimal temporally contiguous partitions ...". This should also make the paper fit in 2 pages. @vissarion I have updated my checklist and I also think this is ready to go. |
@vissarion @ankurankan @gchure Thank you all for engaging us in the JOSS review process and helping us to improve the package! We hope it can serve as a useful tool for people across disciplines using networks in their research. |
Hi @vissarion @gchure @ankurankan, thanks very much for taking the time to review our software and providing valuable suggestions for enhancement. We will ensure to uphold that standard for future modules to maintain a positive and collaborative vibe within the community! |
Thanks, @baiyueh I have a minor comment, see baiyueh/PANINIpy#5 |
When a submission is ready to be accepted, we ask that the authors issue a new tagged release of the software (if changed), and archive it (see this guide). Please do this and post the version number and archive DOI here. |
Hi @vissarion, have addressed the minor issue with the citation. The published the release of PANINIpy-v1.0.1 with DOI: 10.5281/zenodo.14100356. Do let us know if there is anything missing out there. |
@editorialbot set 10.5281/zenodo.14100356 as archive |
Done! archive is now 10.5281/zenodo.14100356 |
@editorialbot set v1.0.1 as version |
Done! version is now v1.0.1 |
@editorialbot generate pdf |
@editorialbot recommend-accept |
|
|
👋 @openjournals/dsais-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#6128, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot generate pdf 🔍 checking out the following:
|
👋 @baiyueh - I just need you to address the following before I accept this one for publication: In the archive:
In the paper:
That's all. This paper was very clean. Thank you for that! Let me know when you have made these changes. |
@editorialbot generate pdf |
Hi @crvernon, thanks for reviewing before the publication. Both issues in the archive and the paper mentioned have been addressed. |
@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 👈 🐘🐘🐘 |
🦋🦋🦋 👉 Bluesky post 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 on your new publication @baiyueh! Many thanks to @vissarion for editing and @ankurankan and @gchure for your time, hard work, and expertise!! JOSS wouldn't be able to function nor succeed without your efforts. Please consider becoming a reviewer for JOSS if you are not already: https://reviewers.joss.theoj.org/join |
🎉🎉🎉 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: @baiyueh (Baiyue He)
Repository: https://github.com/baiyueh/PANINIpy
Branch with paper.md (empty if default branch):
Version: v1.0.1
Editor: @vissarion
Reviewers: @ankurankan, @gchure
Archive: 10.5281/zenodo.14100356
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
@ankurankan & @gchure, 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 @vissarion 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 @gchure
📝 Checklist for @ankurankan
The text was updated successfully, but these errors were encountered: