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]: MultilayerGraphs.jl: Multilayer Network Science in Julia #5116
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 |
|
@editorialbot commands |
Hello @pitmonticone, here are the things you can ask me to do:
|
@editorialbot generate preprint |
📄 Preprint file created: Find it here in the Artifacts list 📄 |
@editorialbot generate pdf |
📄 Preprint file created: Find it here in the Artifacts list 📄 |
Review checklist for @TomKellyGeneticsConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Apologies for the slow follow-up due to unrelated personal reasons. I’m delighted to see that your software is well-documented and the paper is an excellent summary. The writing style differs from my field but it is easily understandable for a non-expert audience. I know from experience this is a difficult tasks that the authors have handled well. Excellent work. Please give me more time to test the installation and run the code before giving more detailed feedback. So far I only have minor suggestions so if the quality of the software is at a similar level, I’d expect only few revisions would be necessary to give my recommendation to accept. |
Hi @bgailleton how is your review going? |
Hi @diehlpk , apologies or the slow review, I should be able to dedicate proper time to it tomorrow/Friday! |
Review checklist for @bgailletonConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Regarding the installation, I was not able to install the package following instructions in the documentation:
I noticed this configuration file restrictions which version of Julia can run it.
Updating Julia 1.6.3 to 1.8.5 resolves this issue.
While the configuration file automates installing other packages as dependencies, the software dependencies necessary for the user to understand should be clearly documented. Please list the minimum version of Julia (1.8) clearly in the installation instructions (e.g., under a 'System requirements' subheading). This should be a simple change to the documentation (and optionally the GitHub README). Regarding the examples, my preference is to include them in the manuscript but I'll defer to editorial guidance and authorial discretion. However, I'll note this was already proposed in "pre-review" stage and the usage is described in the documentation linked: https://juliagraphs.org/MultilayerGraphs.jl/stable/ I'll proceed to review the functionality and usage based on the code examples given there. As there are no original results or data and no performance claims, I'll consider these out of scope of review in this case. Of course, it is well-established that Julia has performance advantages over R and Python but some of the alternatives run packages which call other languages Rcpp (C++) and igraph (C). Regardless of performance, I agree that this work is a welcome addition to the equivalent Julia package ecosystem and do not expect performance results to be included in this case. Regarding community guidelines, I note these are described briefly here (https://juliagraphs.org/MultilayerGraphs.jl/stable/#How-to-Contribute) but Issues or Pull Request templates would be beneficial to guide new contributors. See here for details on how to set it up: I'll update this thread when I've tested the software and completed my review. Thank you for your patience. |
I confirmed that all code examples in the README execute without errors. The Tutorial however, give the following error when running some parts.
Please check it is up-to-date with the current version of the package and can be run without aliases on a new user's environment. On the other hand, the Tutorial does a better job at demonstrating how to call created objects and check their contents. The REPL prints helpful information while executing commands but this would be enhanced by demonstrations on to integrate multilayer graphs with existing systems to print Graph.jl components or visualise the graphs created. Rather than avoiding redundancy with other packages, stand-alone documentation that does not assume users have familiarity with them would be ideal. The authors should be commended for preparing high quality short-form documentation and manuscript which concisely summarises the importance of this contribution. Clearer long-form documentation is recommended but not essential. I'll note that the R packages for this theme do not have vignettes demonstrating this functionality either. For comparison, the documentation for the Leiden clustering algorithm in Python and R (by Vincent Traag and myself respectively) has examples of multilayer graphs with visualisations. As a suggestion to extend this work, Louvain or Leiden clustering would be compatible with this framework. It is a significant amount of work not required to publish in my opinion (but within the scope of issue 94). |
Dear @TomKellyGenetics, thank you very much for your helpful comments. Installation
We have changed the README, example and dev documentation accordingly. The stable documentation will be updated with the registration of the post-publication release. Usage Example
Yes, @diehlpk suggested to create an example folder and to link it to the manuscript, so we did exactly that. Community Guidelines
We have added issue templates accordingly. |
Overall, the package is well-documented (overview, installation, usage and API); the code itself well structured and reasonably well commented; and the manuscript clear, concise and understandable for the non-specialists. I believe it represents a great addition to JOSS and recommend publication, after maybe minor changes. I have just submitted an issue with more detailed comments and eventual recommendations on the repository to keep this thread clear. |
Dear @TomKellyGenetics , I'd like to integrate what's been written by @pitmonticone with two notes regarding the error you got while running the tutorial and the issue about console printing and visualizations. Error inside the Tutorial
I created a fresh environment where only essential packages have been installed: Status `...\Project.toml`
[31c24e10] Distributions v0.25.83
[86223c79] Graphs v1.8.0
[626554b9] MetaGraphs v0.7.2
[af984530] MultilayerGraphs v1.1.3
[b43c691f] SimpleValueGraphs v0.4.1
[47aef6b3] SimpleWeightedGraphs v1.3.0
[2913bbd2] StatsBase v0.33.21 And re-run the parts of the tutorial that instantiate While running the tutorial, I found an error on another line, which I corrected. Console print and Visualisations
We're glad you found the displayed information useful. When a multilayer graph-object, a Regarding visualizations, the package does not have that functionality yet, but, just as the clustering algorithms mentioned above, they are part of the package's future plans. |
@editorialbot generate pdf |
@editorialbot recommend-accept |
|
|
@pitmonticone - I'll come back to this and complete the processing in the next 24 hours |
Thank you @danielskatz and @tarleb for your PRs. I've just reviewed and merged them. |
👋 @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#4014, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🐘🐘🐘 👉 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... |
Congratulations to @pitmonticone (Pietro Monticone) and co-author!! And thanks to @TomKellyGenetics and @bgailleton for reviewing, and to @diehlpk 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:
|
Is it possible to
Thanks in advance. |
👋 @arfon - Can we handle the above requests? |
Quick update on testing the package. I've confirmed this package runs as described on Mac OS (in addition to Windows). I tried running it on a different Linux system but there problems installing dependencies in my environment. This seems to be an issue with dependent packages, not the published work, therefore I think it will not be necessary to report issues to the developers. If that changes, I'll submit issues directly to the package GitHub repository separate from the JOSS review. @pitmonticone @ClaudMor Thank you for your cooperation. |
Hi @danielskatz and @arfon, any update on this? Thanks in advance. |
@arfon will need to respond - I know that I don't have the ability to do this, but he might. |
@pitmonticone – I've updated the citation string on the JOSS website as requested. Unfortunately it's not possible to change the BibTeX key generated on the site. |
Thank you very much @arfon! |
Hi @arfon @danielskatz, Where can I find the .tex source of the paper? |
@editorialbot generate preprint |
📄 Preprint file created: Find it here in the Artifacts list 📄 |
The source of the paper is https://github.com/JuliaGraphs/MultilayerGraphs.jl/tree/JOSS/paper |
Thanks @danielskatz for your reply, but I was referring to the related .tex file. |
Submitting author: @pitmonticone (Pietro Monticone)
Repository: https://github.com/JuliaGraphs/MultilayerGraphs.jl
Branch with paper.md (empty if default branch): JOSS
Version: 1.1.4
Editor: @diehlpk
Reviewers: @TomKellyGenetics, @bgailleton
Archive: 10.5281/zenodo.7697094
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
@TomKellyGenetics & @bgailleton, 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 @diehlpk 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 @TomKellyGenetics
📝 Checklist for @bgailleton
The text was updated successfully, but these errors were encountered: