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]: Back to sequences: find the origin of k-mers #7066

Closed
editorialbot opened this issue Aug 1, 2024 · 71 comments
Closed

[REVIEW]: Back to sequences: find the origin of k-mers #7066

editorialbot opened this issue Aug 1, 2024 · 71 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review Rust Shell TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Aug 1, 2024

Submitting author: @pierrepeterlongo (Pierre Peterlongo)
Repository: https://github.com/pierrepeterlongo/back_to_sequences/
Branch with paper.md (empty if default branch):
Version: v0.6.6
Editor: @majensen
Reviewers: @Anjan-Purkayastha, @amoeba
Archive: 10.5281/zenodo.13794732

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/2b20d0fa287109fb0fcdb39b48b81b21"><img src="https://joss.theoj.org/papers/2b20d0fa287109fb0fcdb39b48b81b21/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/2b20d0fa287109fb0fcdb39b48b81b21/status.svg)](https://joss.theoj.org/papers/2b20d0fa287109fb0fcdb39b48b81b21)

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

@Anjan-Purkayastha & @amoeba, 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:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @majensen 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 @Anjan-Purkayastha

📝 Checklist for @amoeba

@editorialbot
Copy link
Collaborator Author

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:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1186/s13059-022-02771-2 is OK
- 10.1038/nmeth.1376 is OK
- 10.1101/gr.101360.109 is OK
- 10.7717/peerj-cs.94 is OK
- 10.1093/bfgp/elr035 is OK
- 10.1186/s13059-019-1632-4 is OK
- 10.1093/bioinformatics/btu288 is OK
- 10.1093/nar/gku1187 is OK
- 10.1093/bioadv/vbac029 is OK
- 10.1101/gr.277615.122 is OK
- 10.1145/585265.585267 is OK
- 10.1089/cmb.2012.0021 is OK
- 10.1016/j.dam.2018.03.035 is OK
- 10.1186/s13059-019-1891-0 is OK
- 10.1038/s41579-020-0364-5 is OK
- 10.1093/bioinformatics/btac689 is OK
- 10.1186/s12864-015-1406-7 is OK
- 10.1016/j.isci.2023.108057 is OK

MISSING DOIs

- No DOI given, and none found for title: The Platinum Searcher
- No DOI given, and none found for title: The Silver Searcher
- No DOI given, and none found for title: Kmer Mapper
- No DOI given, and none found for title: AHash: A Load-Balanced One Permutation Hash

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.02 s (1554.0 files/s, 235858.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Rust                            11            357            216           1792
CSV                              3              0              0           1497
Markdown                         6            118              0            469
TeX                              1             26              3            216
Python                           6             50             37            152
Bourne Shell                     4             38             23            144
YAML                             3             17              0            102
TOML                             1             12              5             38
-------------------------------------------------------------------------------
SUM:                            35            618            284           4410
-------------------------------------------------------------------------------

Commit count by author:

   134	Pierre Peterlongo
    14	Pierre Marijon
    10	Anthony Baire
     7	PETERLONGO Pierre
     1	Francesco Andreace

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 2348

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

🟡 License found: GNU Affero General Public License v3.0 (Check here for OSI approval)

@editorialbot
Copy link
Collaborator Author

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

@Anjan-Purkayastha
Copy link

Anjan-Purkayastha commented Aug 1, 2024

Review checklist for @Anjan-Purkayastha

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 https://github.com/pierrepeterlongo/back_to_sequences/?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@pierrepeterlongo) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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, who the target audience is, and its relation to other work?
  • 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?

@majensen
Copy link
Member

@Anjan-Purkayastha @amoeba thanks for agreeing to review. Let me know if there are any blockers for you. Mark

@amoeba
Copy link

amoeba commented Aug 12, 2024

Hey @majensen, I can have my review in by Aug 18 if that timeline works.

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

I'm sorry @Anjan-Purkayastha, I'm afraid I can't do that. That's something only editors are allowed to do.

@Anjan-Purkayastha
Copy link

@majensen: Have completed installing and testing the tool. It is a useful addition to the set of general-purpose bioinformatics tools we use for processing NGS data.
I have left some good enhancement suggestion at this link, for the authors. Aside from this, they need to update their citations, and they should be good to go.
This is my first time interacting over GitHub, please do let me know if there is anything else I need to do to complete this review. Cheers.

@majensen
Copy link
Member

Thanks very much @Anjan-Purkayastha -

@amoeba
Copy link

amoeba commented Aug 20, 2024

Review checklist for @amoeba

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 https://github.com/pierrepeterlongo/back_to_sequences/?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@pierrepeterlongo) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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, who the target audience is, and its relation to other work?
  • 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?

@amoeba
Copy link

amoeba commented Aug 20, 2024

Hi @majensen and @pierrepeterlongo, I've finished my review and filed an issue on your repo. I do ask for some changes there so please have a look and let me know when you'd like me to re-review.

@majensen
Copy link
Member

Hi @pierrepeterlongo - the reviewers have made their comments and have items to address at pierrepeterlongo/back_to_sequences#6 and pierrepeterlongo/back_to_sequences#8. Please keep us informed on your progress here as you work through these. Thanks!

@pierrepeterlongo
Copy link

Hi @majensen
Thanks a lot for your message. I'm planning to apply the (nice) recommendations by the end of the week.

Pierre

@pierrepeterlongo
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@pierrepeterlongo
Copy link

Hello @majensen,

We took in consideration reviewer's comments. I closed the related issues. pierrepeterlongo/back_to_sequences#6 and pierrepeterlongo/back_to_sequences#8.

Best,
Pierrre

@majensen
Copy link
Member

majensen commented Aug 28, 2024

Thanks @pierrepeterlongo - I am fine with your solution regarding the length of the paper (I tend to be lenient on this aspect). @amoeba @Anjan-Purkayastha if you would have a look this week that would be excellent.
Thanks!

@editorialbot
Copy link
Collaborator Author

Done! version is now 0.6.6

@pierrepeterlongo
Copy link

One minor update @pierrepeterlongo - can you make the title of the repo https://doi.org/10.5281/zenodo.13794732 the same as that of the paper, ie "Back to sequences: find the origin of k-mers"? This is something JOSS requires.

Done :)

@majensen
Copy link
Member

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.1186/s13059-022-02771-2 is OK
- 10.1038/nmeth.1376 is OK
- 10.1101/gr.101360.109 is OK
- 10.7717/peerj-cs.94 is OK
- 10.1093/bfgp/elr035 is OK
- 10.1186/s13059-019-1632-4 is OK
- 10.1093/bioinformatics/btu288 is OK
- 10.1093/nar/gku1187 is OK
- 10.1093/bioadv/vbac029 is OK
- 10.1101/gr.277615.122 is OK
- 10.1145/585265.585267 is OK
- 10.1089/cmb.2012.0021 is OK
- 10.1016/j.dam.2018.03.035 is OK
- 10.1186/s13059-019-1891-0 is OK
- 10.1038/s41579-020-0364-5 is OK
- 10.1093/bioinformatics/btac689 is OK
- 10.1186/s12864-015-1406-7 is OK
- 10.1016/j.isci.2023.108057 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: The Platinum Searcher
- No DOI given, and none found for title: The Silver Searcher
- No DOI given, and none found for title: Kmer Mapper
- No DOI given, and none found for title: AHash: A Load-Balanced One Permutation Hash

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/bcm-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#5895, 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 Sep 20, 2024
@editorialbot
Copy link
Collaborator Author

I'm sorry @pierrepeterlongo, I'm afraid I can't do that. That's something only eics are allowed to do.

@majensen
Copy link
Member

@pierrepeterlongo - I should explain that I as the topic editor do the "recommend-accept" command, which does some checks and then informs the Editors-in-chief. One of them will come soon and do a final check - they may have questions or minor fixes. When they are satisfied, they'll push the big button that publishes the paper officially.
Thanks!

@pierrepeterlongo
Copy link

Yep this is what I understood, a bit late :)

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Sep 23, 2024

@pierrepeterlongo as AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I will now process some final checks:

Checks on repository

  • Project has OSI approved license
  • Project features contributing guidelines

Checks on review issue

  • Review completed
  • Software license tag listed here matches a tagged release

Checks on archive

  • Archive listed title and authors matches paper
  • Archive listed license matches software license
  • Archive listed version tag matches tagged release (and includes a potential v).

Checks on paper

  • Checked paper formatting
  • Check affiliations to make sure country acronyms are not used
  • Checked reference rendering
  • Checked if pre-print citations can be updated by published versions
  • Checked for typos

Remaining points:

As you can see, most seems in order, however the below are some points that require your attention 👇 :

  • Please edit the archive listed version to be v0.6.6, i.e. make sure to include the v from your version tag.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set v0.6.6 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v0.6.6

@pierrepeterlongo
Copy link

Hello.

I also changed the zenodo version label from 0.6.6 to v0.6.6

https://zenodo.org/records/13794732

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

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

cff-version: "1.2.0"
authors:
- family-names: Baire
  given-names: Anthony
- family-names: Marijon
  given-names: Pierre
  orcid: "https://orcid.org/0000-0002-6694-6873"
- family-names: Andreace
  given-names: Francesco
  orcid: "https://orcid.org/0009-0008-0566-200X"
- family-names: Peterlongo
  given-names: Pierre
  orcid: "https://orcid.org/0000-0003-0776-6407"
doi: 10.5281/zenodo.13794732
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Baire
    given-names: Anthony
  - family-names: Marijon
    given-names: Pierre
    orcid: "https://orcid.org/0000-0002-6694-6873"
  - family-names: Andreace
    given-names: Francesco
    orcid: "https://orcid.org/0009-0008-0566-200X"
  - family-names: Peterlongo
    given-names: Pierre
    orcid: "https://orcid.org/0000-0003-0776-6407"
  date-published: 2024-09-23
  doi: 10.21105/joss.07066
  issn: 2475-9066
  issue: 101
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7066
  title: "Back to sequences: Find the origin of k-mers"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07066"
  volume: 9
title: "Back to sequences: Find the origin of $k$-mers"

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.

Find more information on .cff files here and here.

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 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.07066 joss-papers#5902
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.07066
  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 Sep 23, 2024
@majensen
Copy link
Member

Congrats @pierrepeterlongo and thanks so much for the reviews @amoeba and @Anjan-Purkayastha !

@pierrepeterlongo
Copy link

Thank you all. I was a great experience to submit this work to JOSS.

@pierrepeterlongo
Copy link

Just a last comment, if it is possible, maybe remove the '$'s in the title on the JOSS page:
screenshot 2024-09-23 à 21 41 51

@Kevin-Mattheus-Moerman
Copy link
Member

@openjournals/dev @arfon how do we go about removing those dollar symbols? ☝️

@xuanxu
Copy link
Member

xuanxu commented Sep 28, 2024

Updated!

@pierrepeterlongo
Copy link

Perfect, thanks!

@Kevin-Mattheus-Moerman
Copy link
Member

Great, since that is all set we are good to close this review.

Congratulations @pierrepeterlongo on this JOSS publication!

Thanks @majensen for editing!

And a special thank you to the reviewers: @Anjan-Purkayastha, @amoeba !!

@editorialbot
Copy link
Collaborator Author

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

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

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

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 published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review Rust Shell TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials
Projects
None yet
Development

No branches or pull requests

7 participants