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]: ROCK: digital normalization of whole genome sequencing data #3790

Closed
40 tasks done
whedon opened this issue Oct 1, 2021 · 51 comments
Closed
40 tasks done

[REVIEW]: ROCK: digital normalization of whole genome sequencing data #3790

whedon opened this issue Oct 1, 2021 · 51 comments
Assignees
Labels
accepted M4 Makefile published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review Shell

Comments

@whedon
Copy link

whedon commented Oct 1, 2021

Submitting author: @alex2cris (alexis criscuolo)
Repository: https://gitlab.pasteur.fr/vlegrand/ROCK
Branch with paper.md (empty if default branch):
Version: v_1.9.6
Editor: @luizirber
Reviewers: @hiraksarkar, @ctb
Archive: 10.5281/zenodo.6527091

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

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

@hiraksarkar and @ctb, 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 @luizirber 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 @hiraksarkar

✨ 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 (@alex2cris) 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 @ctb

✨ 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 (@alex2cris) 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 1, 2021

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

Wordcount for paper.md is 1929

@whedon
Copy link
Author

whedon commented Oct 1, 2021

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

OK DOIs

- 10.1016/j.ygeno.2013.07.011 is OK
- 10.12688/f1000research.6924.1 is OK
- 10.1016/j.jalgor.2003.12.001 is OK
- 10.1038/s41598-019-41502-9 is OK
- 10.3390/electronics8070779 is OK
- 10.1093/bioinformatics/btw832 is OK
- 10.1186/s12859-017-1724-7 is OK
- 10.1371/journal.pone.0101271 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Oct 1, 2021

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.07 s (790.7 files/s, 249304.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Bourne Shell                     9            811           1638           7333
C++                             18            670            773           2647
m4                               2            108             22            976
C/C++ Header                    16            394            389            739
Markdown                         2             92              0            212
TeX                              1             10              0             91
make                             4             23              2             54
YAML                             1              3              0             25
XML                              1              0              0             15
-------------------------------------------------------------------------------
SUM:                            54           2111           2824          12092
-------------------------------------------------------------------------------


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

Author                     Commits    Insertions      Deletions    % of changes
Nicolas Joly                     7            36             16            0.23
Veronique Legrand              166         15790           6409           99.76
Véronique Legrand                1             1              1            0.01

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
Veronique Legrand          5612           35.5         31.4               25.41

@whedon
Copy link
Author

whedon commented Oct 1, 2021

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

@kyleniemeyer
Copy link

@whedon add @ctb as reviewer

@whedon whedon assigned ctb and luizirber and unassigned luizirber Oct 1, 2021
@whedon
Copy link
Author

whedon commented Oct 1, 2021

OK, @ctb is now a reviewer

@kyleniemeyer
Copy link

@luizirber FYI, if the missing reviewer thing ever happens again, you can just give the add command here, then you need to manually edit whedon's initial comment to add the missing reviewer checklist

@alex2cris
Copy link

@VeroniqueLegrand @tkergrohen the ROCK [REVIEW] issue is here now

@whedon
Copy link
Author

whedon commented Oct 15, 2021

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

@hiraksarkar
Copy link

Hi @luizirber , it seems this invitation https://github.com/openjournals/joss-reviews/invitations is expired, do I need to click on this to edit the checklist? or Should I open a new issue?

@arfon
Copy link
Member

arfon commented Oct 18, 2021

@whedon re-invite @hiraksarkar as reviewer

@whedon
Copy link
Author

whedon commented Oct 18, 2021

OK, the reviewer has been re-invited.

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

@arfon
Copy link
Member

arfon commented Oct 18, 2021

Could you try again now please @hiraksarkar?

@alex2cris
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Dec 9, 2021

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

@alex2cris
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 24, 2022

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

@arfon
Copy link
Member

arfon commented Feb 27, 2022

👋 @hiraksarkar, @ctb – looks like we're waiting on your reviews here. Do you think you could complete your initial reviews in the next couple of weeks?

@ctb
Copy link

ctb commented Feb 28, 2022

yep, will get on it.

@hiraksarkar
Copy link

hiraksarkar commented May 6, 2022

@luizirber I completed my review, and all my raised issues are addressed

Very nicely executed work. Amazing job by the authors. I am unable to correct the checklist here. The completed checklist is here.

@luizirber
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator

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

@luizirber
Copy link

@alex2cris can you please cut a new DOI for archival and report

  • version number
  • archive DOI

(almost done! so close!)

@luizirber
Copy link

@editorialbot check references

@editorialbot
Copy link
Collaborator

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

OK DOIs

- 10.1016/j.ygeno.2013.07.011 is OK
- 10.12688/f1000research.6924.1 is OK
- 10.1016/j.jalgor.2003.12.001 is OK
- 10.1038/s41598-019-41502-9 is OK
- 10.3390/electronics8070779 is OK
- 10.1093/bioinformatics/btw832 is OK
- 10.1186/s12859-017-1724-7 is OK
- 10.1371/journal.pone.0101271 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@alex2cris
Copy link

Dear @luizirber

The current version is: 1.9.6
This version is tagged in the gitlab repository (https://gitlab.pasteur.fr/vlegrand/ROCK)

I also made a DOI for this version at Zenodo: 10.5281/zenodo.6527091
(https://zenodo.org/record/6527091)

Hope that everything is ok.

Best regards,

-- Alexis --

@alex2cris
Copy link

@whedon generate pdf

@editorialbot
Copy link
Collaborator

My name is now @editorialbot

@alex2cris
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator

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

@luizirber
Copy link

@editorialbot set 10.5281/zenodo.6527091 as archive

@editorialbot
Copy link
Collaborator

Done! Archive is now 10.5281/zenodo.6527091

@luizirber
Copy link

@editorialbot set v_1.9.6 as version

@editorialbot
Copy link
Collaborator

Done! version is now v_1.9.6

@luizirber
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator

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

OK DOIs

- 10.1016/j.ygeno.2013.07.011 is OK
- 10.12688/f1000research.6924.1 is OK
- 10.1016/j.jalgor.2003.12.001 is OK
- 10.1038/s41598-019-41502-9 is OK
- 10.3390/electronics8070779 is OK
- 10.1093/bioinformatics/btw832 is OK
- 10.1186/s12859-017-1724-7 is OK
- 10.1371/journal.pone.0101271 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator

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

Check final proof 👉 openjournals/joss-papers#3204

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3204, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label May 7, 2022
@kyleniemeyer
Copy link

@editorialbot accept

@editorialbot
Copy link
Collaborator

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

@editorialbot
Copy link
Collaborator

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

@editorialbot
Copy link
Collaborator

🚨🚨🚨 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.03790 joss-papers#3205
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03790
  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...

@editorialbot editorialbot added accepted published Papers published in JOSS labels May 7, 2022
@kyleniemeyer
Copy link

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

Many thanks to @hiraksarkar and @ctb for reviewing this, and @luizirber for editing.

@editorialbot
Copy link
Collaborator

🎉🎉🎉 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.03790/status.svg)](https://doi.org/10.21105/joss.03790)

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

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

This is how it will look in your documentation:

DOI

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:

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

No branches or pull requests

8 participants