Skip to content

[REVIEW]: sknet: A Python framework for Machine Learning in Complex Networks #3864

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

Closed
60 tasks done
whedon opened this issue Oct 28, 2021 · 75 comments
Closed
60 tasks done
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Oct 28, 2021

Submitting author: @TNanukem (Tiago Toledo Junior)
Repository: https://github.com/TNanukem/scikit-net/
Version: v0.0.1
Editor: @osorensen
Reviewers: @dvysardana, @drj11, @imw
Archive: 10.5281/zenodo.5783027

⚠️ 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/6a2c114ff1c64ff07bd4735638515359"><img src="https://joss.theoj.org/papers/6a2c114ff1c64ff07bd4735638515359/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/6a2c114ff1c64ff07bd4735638515359/status.svg)](https://joss.theoj.org/papers/6a2c114ff1c64ff07bd4735638515359)

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

@dvysardana & @drj11, 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 @osorensen 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 @dvysardana

✨ 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 (@TNanukem) 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 @drj11

✨ 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 (@TNanukem) 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 @imw

✨ 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 (@TNanukem) 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 Oct 28, 2021

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @dvysardana, @drj11 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 Oct 28, 2021

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.06 s (1133.7 files/s, 66119.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          22            586            955           1207
reStructuredText                32            204            252            342
YAML                             5             18              1             79
HTML                             2              1              0             66
Bourne Shell                     1             31             16             62
Markdown                         3             26              0             52
DOS Batch                        1              8              1             26
CSS                              1              2              0             11
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            68            880           1232           1854
-------------------------------------------------------------------------------


Statistical information for the repository 'ab4397100d0d540f281a770c' was
gathered on 2021/10/28.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
Tiago Toledo Junior             30          3619            786          100.00

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
Tiago Toledo Junior        2833           78.3          3.3                6.99

@whedon
Copy link
Author

whedon commented Oct 28, 2021

PDF failed to compile for issue #3864 with the following error:

 Can't find any papers to compile :-(

@drj11
Copy link

drj11 commented Oct 29, 2021

@osorensen the PDF isn't compiling. Should it be? Is that where i would expect to find the full author list?

@osorensen
Copy link
Member

Thanks for letting me know @drj11. The paper is in a separate branch, so we need some special syntax.

@osorensen
Copy link
Member

@whedon generate pdf from branch docs/joss_paper

@whedon
Copy link
Author

whedon commented Oct 29, 2021

Attempting PDF compilation from custom branch docs/joss_paper. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 29, 2021

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

@drj11
Copy link

drj11 commented Oct 29, 2021

Good work whedon!

@dvysardana
Copy link

@osorensen, @whedon, I have completed my review.

@osorensen
Copy link
Member

Thanks @dvysardana. Do I understand correctly that you think a statement of need is missing but otherwise everything is fine?

@dvysardana
Copy link

dvysardana commented Nov 1, 2021 via email

@osorensen
Copy link
Member

Thanks a lot for your review @dvysardana . I can confirm that you have done what is requested for now, but once the authors report in this thread that they have added a statement if need and a target audience, please come back and compete the review checklist. I will tag you in this thread to make sure you get notified.

@TNanukem
Copy link

TNanukem commented Nov 2, 2021

@whedon generate pdf from branch docs/joss_paper

@whedon
Copy link
Author

whedon commented Nov 2, 2021

Attempting PDF compilation from custom branch docs/joss_paper. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Nov 2, 2021

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

@TNanukem
Copy link

TNanukem commented Nov 2, 2021

Hello @dvysardana

I've added more information about the target audience on the README and on the sphinx documentation.
Also, I added more information about other packages on the paper.

Do those changes meet the criteria for your revision? If not, do you have any suggestions on how to improve it to make it acceptable?

Thank you for your review!

@dvysardana
Copy link

dvysardana commented Nov 2, 2021 via email

@TNanukem
Copy link

TNanukem commented Nov 4, 2021

Thank you @dvysardana.

If anything else comes up I'm available for the changes proposed by you or @drj11 :)

@osorensen
Copy link
Member

@dvysardana, please also remember to check the two reminaing boxes in your review checklist at the top of this issue.

@dvysardana
Copy link

dvysardana commented Nov 4, 2021 via email

@whedon
Copy link
Author

whedon commented Nov 11, 2021

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

@drj11
Copy link

drj11 commented Nov 11, 2021

Oh good reminder @whedon I'll have a look this afternoon.

@osorensen
Copy link
Member

@drj11, how is it going with your review? If there are issues which you think the authors should address, please mention them in this thread or by opening an issue in the source repository.

@whedon
Copy link
Author

whedon commented Dec 15, 2021

Attempting PDF compilation from custom branch docs/joss_paper. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Dec 15, 2021

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

@TNanukem
Copy link

@whedon generate pdf from branch docs/joss_paper

@whedon
Copy link
Author

whedon commented Dec 15, 2021

Attempting PDF compilation from custom branch docs/joss_paper. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Dec 15, 2021

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

@osorensen
Copy link
Member

@whedon set 10.5281/zenodo.5783027 as archive

@whedon
Copy link
Author

whedon commented Dec 15, 2021

OK. 10.5281/zenodo.5783027 is the archive.

@osorensen
Copy link
Member

@whedon set v0.0.1 as version

@whedon
Copy link
Author

whedon commented Dec 15, 2021

OK. v0.0.1 is the version.

@osorensen
Copy link
Member

@whedon recommend-accept

@whedon
Copy link
Author

whedon commented Dec 15, 2021

Attempting dry run of processing paper acceptance...

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

whedon commented Dec 15, 2021

PDF failed to compile for issue #3864 with the following error:

 Can't find any papers to compile :-(

@osorensen
Copy link
Member

@whedon recommend-accept from branch docs/joss_paper

@whedon
Copy link
Author

whedon commented Dec 15, 2021

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Dec 15, 2021

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

Check final proof 👉 openjournals/joss-papers#2825

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

@whedon accept deposit=true from branch docs/joss_paper 

@whedon
Copy link
Author

whedon commented Dec 15, 2021

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

OK DOIs

- 10.1007/978-3-319-17290-3 is OK
- 10.1016/j.neucom.2011.04.042 is OK
- 10.1016/j.neucom.2014.03.071 is OK
- 10.1109/TNNLS.2012.2195027 is OK
- 10.1109/TNNLS.2011.2181866 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@kyleniemeyer
Copy link

@whedon accept deposit=true from branch docs/joss_paper

@whedon
Copy link
Author

whedon commented Dec 15, 2021

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

@whedon whedon added accepted published Papers published in JOSS labels Dec 15, 2021
@whedon
Copy link
Author

whedon commented Dec 15, 2021

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

@whedon
Copy link
Author

whedon commented Dec 15, 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.03864 joss-papers#2829
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03864
  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...

@kyleniemeyer
Copy link

Congratulations @TNanukem on your article's publication in JOSS!

Many thanks to @dvysardana, @drj11, and @imw for reviewing this, and @osorensen for editing.

@whedon
Copy link
Author

whedon commented Dec 15, 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.03864/status.svg)](https://doi.org/10.21105/joss.03864)

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

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

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 Python recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

7 participants