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]: sourmash v4: A multitool to quickly search, compare, and analyze genomic and metagenomic data sets #6830

Closed
editorialbot opened this issue Jun 3, 2024 · 82 comments
Assignees
Labels
accepted C published Papers published in JOSS pyOpenSci Submissions associated with pyOpenSci Python recommend-accept Papers recommended for acceptance in JOSS. review Rust Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Jun 3, 2024

Submitting author: @bluegenes (N. Tessa Pierce-Ward)
Repository: https://github.com/sourmash-bio/sourmash
Branch with paper.md (empty if default branch):
Version: v4.8.9
Editor: @Kevin-Mattheus-Moerman
Reviewers: @Kevin-Mattheus-Moerman
Archive: 10.5281/zenodo.11557883

Status

status

Status badge code:

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

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

@bede & @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

@bede, please create your checklist typing: @editorialbot generate my checklist

@amoeba, please create your checklist typing: @editorialbot generate my checklist

@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.1101/029827 is OK
- 10.21105/joss.00027 is OK
- 10.12688/f1000research.19675.1 is OK
- 10.1101/2022.01.11.475838 is OK
- 10.1101/2022.11.02.514947 is OK
- 10.1016/j.amc.2019.02.018 is OK
- 10.1101/gr.277651.123 is OK
- 10.1101/2023.11.06.565843 is OK
- 10.1186/s12859-022-05103-0 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.94 s (493.5 files/s, 199723.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Standard ML                     97              0              0          57302
Python                         151          16321           7734          55735
SVG                              1              5              0          12420
Rust                            49           2294            858          11536
Markdown                        50           2606              0           7994
CSV                             56             11              0           5733
YAML                            15            123             20            775
TOML                             6             45              8            379
C/C++ Header                     1            163             46            275
Jupyter Notebook                 5              0           3572            271
make                             2             49              6            242
INI                              1             20              0            224
HTML                             1             45              3            146
Nix                              3             30             10            130
TeX                              1              8              0             88
JSON                            19              1              0             50
reStructuredText                 1              6              0             28
Rmd                              1             16             23             17
CSS                              1              2              0              8
Bourne Shell                     2              0              0              6
-------------------------------------------------------------------------------
SUM:                           463          21745          12280         153359
-------------------------------------------------------------------------------

Commit count by author:

   995	C. Titus Brown
   301	dependabot[bot]
   251	Luiz Irber
    65	Tessa Pierce Ward
    28	Laurent Gautier
    22	Keya Barve
    12	Tim Head
    10	Mohamed Abuelanin
     8	Olga Botvinnik
     7	Erik Young
     7	Taylor Reiter
     5	Pranathi Vemuri
     4	Connor Tiffany
     4	Tessa Pierce
     4	dependabot-preview[bot]
     3	Hannah Eve Houts
     3	S. Joshua Swamidass
     3	brooksph
     2	Camille Scott
     2	Daniel Standage
     2	David Koslicki
     2	Harriet Alexander
     2	Jason Stajich
     2	Peter Cock
     2	Titus Brown
     2	ccbaumler
     1	Abhishek Anant
     1	Andreas Sjödin
     1	Arfon Smith
     1	Brad Nelson
     1	Colton Baumler
     1	Connor T. Skennerton
     1	Daniel Dsouza
     1	Fabian Klötzl
     1	Francesco Beghini
     1	Ivan Ogasawara
     1	Katrin Leinweber
     1	Marisa Lim
     1	NapsterInBlue
     1	Phillip Brooks
     1	Ria Lodh
     1	Ricky Lim
     1	jgardner78
     1	ljcohen
     1	pyup.io bot

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 821

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

🟡 License found: Other (Check here for OSI approval)

@editorialbot
Copy link
Collaborator Author

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

@bluegenes
Copy link

bluegenes commented Jun 5, 2024

Thanks all! Note pyopensci review (accepted) here: pyOpenSci/software-submission#129

@lwasser
Copy link

lwasser commented Jun 5, 2024

hey @majensen 👋🏻 just to add to @bluegenes comment above, this package has already been reviewed by pyOpenSci. as such you will only need to review the paper / scope etc. The code should not be reviewed again. I am adding this note because i see two reviewers have been assigned. in the past, credit has been given to the reviewers on the pyOpenSci side of things who in this case are.

@LilyAnderssonLee
@elais

@arfon can also answer any questions if you have them! 🙌🏻

@majensen
Copy link
Member

majensen commented Jun 6, 2024

Thanks all. So this the horse of a different color I've heard tell about. I will follow the SOP and move this along!

@lwasser
Copy link

lwasser commented Jun 6, 2024

@majensen 😆 i believe it is. i'm just curious - from your perspective as an editor - what could we (pyopensci / joss) do differently that would help make it more clear that is it a pyopensci fast track when such a package enters into your review process? and also - thank you!!

@majensen
Copy link
Member

majensen commented Jun 6, 2024

@lwasser well unless I missed it in the autogenerated material (very possible), I think it was @bluegenes herself who informed me in the thread. I wonder @openjournals/dev if there is a natural way to interconnect between the journals (one of the paper metadata files?), so that maybe a tag is autoadded or some other info is provided to give the editor a heads-up. I admit this my first time handling one of these over almost 5yr.

@lwasser
Copy link

lwasser commented Jun 6, 2024

ahhhh good to know. and so good that @bluegenes posted here (and i was tagged in our slack as well!) . an auto label would be really nice and would make things easier. a check box in the review submission that triggers the bot to create a pyOpenSci approved label? that is a great idea.

@bluegenes
Copy link

hi all! Just fyi - I believe I included the info in the note to editor during submission, so I'm not sure if that got over to you or not. Thanks @lwasser for your help getting the reviews linked!

@majensen
Copy link
Member

@bede, @amoeba - thanks for being willing to review this paper. It looks like it has already been reviewed and is being routed to JOSS for final publication. I will remove you as reviewers, but the gratitude will remain!

@majensen
Copy link
Member

@editorialbot remove @bede as reviewer

@editorialbot
Copy link
Collaborator Author

@bede removed from the reviewers list!

@majensen
Copy link
Member

@editorialbot remove @amoeba as reviewer

@editorialbot
Copy link
Collaborator Author

@amoeba removed from the reviewers list!

@majensen
Copy link
Member

@editorialbot add @LilyAnderssonLee as reviewer

@editorialbot
Copy link
Collaborator Author

@LilyAnderssonLee added to the reviewers list!

@majensen
Copy link
Member

@editorialbot add @elais as reviewer

@editorialbot
Copy link
Collaborator Author

@elais added to the reviewers list!

@majensen
Copy link
Member

@editorialbot set 10.5281/zenodo.10951577 as archive

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot remove @majensen as editor

@editorialbot
Copy link
Collaborator Author

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot assign me as editor

@editorialbot
Copy link
Collaborator Author

Assigned! @Kevin-Mattheus-Moerman is now the editor

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot add @Kevin-Mattheus-Moerman as reviewer

@editorialbot
Copy link
Collaborator Author

@Kevin-Mattheus-Moerman added to the reviewers list!

@Kevin-Mattheus-Moerman Kevin-Mattheus-Moerman added the pyOpenSci Submissions associated with pyOpenSci label Jun 23, 2024
@Kevin-Mattheus-Moerman
Copy link
Member

Added pyOpenSci label, as this was already reviewed here: pyOpenSci/software-submission#129

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Jun 23, 2024

@bluegenes apologies for the kinks in the cable with this review as I initially missed this was a pyOpenSci related submission. All is good/cleared up now and we are good to proceed. As AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I have checked the pyOpenSci review, your repository, the archive link, and the paper. Most seems in order, however the below are some points that require your attention:

On the archive:

  • I updated the archive as the one listed was for the wrong version. Please can you confirm this is correct, i.e. this review is for tagged release version v4.8.9 which is archived here 10.5281/zenodo.11557883.
  • Please edit the ZENODO listed license to match your software license. It currently lists this:
    image
    But it should refer to you actual BSD-3-Clause license. You need to process this change by manually editing your archive entry.

On the paper:

  • Please add city, state, country to all affiliations, and please spell out country names, so use United States of America in full.

@ctb
Copy link

ctb commented Jun 23, 2024

I changed the LICENSE just now - good catch, we'll have to edit the .zenodo.json to fix that more permanently!

In re the authors, we do not have that level of affiliation for many of them, and would need to put in a lot of work to get it - with no guarantee of success, since this is now a 9 year old package. We do have their ORCIDs, of course, but not all (most?) of the ORCIDs have public affiliation information. Could you confirm this is necessary for publication?

Last but not least - if we do need to update the information on that scale, we will probably do so via .zenodo.json and then would release a new version, v4.8.10. So that would be the version to list then.

thanks!

@Kevin-Mattheus-Moerman
Copy link
Member

@ctb thanks for fixing the license listed on ZENODO.

On the affiliations, this was relating to the paper, not the ZENODO archive. Also I am not asking for a major change. I only ask that for the 9 affiliations listed in the paper, that you check if you know and can add the city, state, country where possible. This would be to conform to our guidelines better but is no strict required for publication in that sense. So for instance in the case of 1. University of California, Davis you could use e.g. 1 University of California Davis, Davis, CA, United States of America, and for 2 Woods Hole Oceanic Institution you could use e.g. 2 Woods Hole Oceanic Institution, Woods Hole, MA, Unites States of America.

Since this is only an affiliation rendering update as a minor change in paper.md there is no need to mint a new version etc. Hope this helps. Hope you can make this minor change where possible.

Once completed as a minor paper change I think we can stick with v4.8.9 but you can decide on that, please let me know.

@ctb
Copy link

ctb commented Jun 25, 2024

Since this is only an affiliation rendering update as a minor change in paper.md there is no need to mint a new version etc. Hope this helps. Hope you can make this minor change where possible.

thank you so much! that makes a lot of sense :). I'm traveling and it may take us a day or three to make these changes, but will do!

@Kevin-Mattheus-Moerman
Copy link
Member

@ctb that is no problem, you can ping me here once you are ready.

@ctb
Copy link

ctb commented Jun 26, 2024

Addresses fixed (by @bluegenes) in latest branch on github! @Kevin-Mattheus-Moerman

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@Kevin-Mattheus-Moerman
Copy link
Member

@ctb thanks for making those changes. I have checked the review over at pyOpenSci/software-submission#129, and I have also checked your repository, the archive link, and the paper. All is now in order, so I will now proceed to accept this submission.

@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: Irber
  given-names: Luiz
  orcid: "https://orcid.org/0000-0003-4371-9659"
- family-names: Pierce-Ward
  given-names: N. Tessa
  orcid: "https://orcid.org/0000-0002-2942-5331"
- family-names: Abuelanin
  given-names: Mohamed
  orcid: "https://orcid.org/0000-0002-3419-4785"
- family-names: Alexander
  given-names: Harriet
  orcid: "https://orcid.org/0000-0003-1308-8008"
- family-names: Anant
  given-names: Abhishek
  orcid: "https://orcid.org/0000-0002-5751-2010"
- family-names: Barve
  given-names: Keya
  orcid: "https://orcid.org/0000-0003-3241-2117"
- family-names: Baumler
  given-names: Colton
  orcid: "https://orcid.org/0000-0002-5926-7792"
- family-names: Botvinnik
  given-names: Olga
  orcid: "https://orcid.org/0000-0003-4412-7970"
- family-names: Brooks
  given-names: Phillip
  orcid: "https://orcid.org/0000-0003-3987-244X"
- family-names: Dsouza
  given-names: Daniel
  orcid: "https://orcid.org/0000-0001-7843-8596"
- family-names: Gautier
  given-names: Laurent
  orcid: "https://orcid.org/0000-0003-0638-3391"
- family-names: Hera
  given-names: Mahmudur Rahman
  orcid: "https://orcid.org/0000-0002-5992-9012"
- family-names: Houts
  given-names: Hannah Eve
  orcid: "https://orcid.org/0000-0002-7954-4793"
- family-names: Johnson
  given-names: Lisa K.
  orcid: "https://orcid.org/0000-0002-3600-7218"
- family-names: Klötzl
  given-names: Fabian
  orcid: "https://orcid.org/0000-0002-6930-0592"
- family-names: Koslicki
  given-names: David
  orcid: "https://orcid.org/0000-0002-0640-954X"
- family-names: Lim
  given-names: Marisa
  orcid: "https://orcid.org/0000-0003-2097-8818"
- family-names: Lim
  given-names: Ricky
  orcid: "https://orcid.org/0000-0003-1313-7076"
- family-names: Nelson
  given-names: Bradley
  orcid: "https://orcid.org/0009-0001-1553-932X"
- family-names: Ogasawara
  given-names: Ivan
  orcid: "https://orcid.org/0000-0001-5049-4289"
- family-names: Reiter
  given-names: Taylor
  orcid: "https://orcid.org/0000-0002-7388-421X"
- family-names: Scott
  given-names: Camille
  orcid: "https://orcid.org/0000-0001-8822-8779"
- family-names: Sjödin
  given-names: Andreas
  orcid: "https://orcid.org/0000-0001-5350-4219"
- family-names: Standage
  given-names: Daniel
  orcid: "https://orcid.org/0000-0003-0342-8531"
- family-names: Swamidass
  given-names: S. Joshua
  orcid: "https://orcid.org/0000-0003-2191-0778"
- family-names: Tiffany
  given-names: Connor
  orcid: "https://orcid.org/0000-0001-8188-7720"
- family-names: Vemuri
  given-names: Pranathi
  orcid: "https://orcid.org/0000-0002-5748-9594"
- family-names: Young
  given-names: Erik
  orcid: "https://orcid.org/0000-0002-9195-9801"
- family-names: Brown
  given-names: C. Titus
  orcid: "https://orcid.org/0000-0001-6001-2677"
contact:
- family-names: Brown
  given-names: C. Titus
  orcid: "https://orcid.org/0000-0001-6001-2677"
doi: 10.5281/zenodo.11557883
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Irber
    given-names: Luiz
    orcid: "https://orcid.org/0000-0003-4371-9659"
  - family-names: Pierce-Ward
    given-names: N. Tessa
    orcid: "https://orcid.org/0000-0002-2942-5331"
  - family-names: Abuelanin
    given-names: Mohamed
    orcid: "https://orcid.org/0000-0002-3419-4785"
  - family-names: Alexander
    given-names: Harriet
    orcid: "https://orcid.org/0000-0003-1308-8008"
  - family-names: Anant
    given-names: Abhishek
    orcid: "https://orcid.org/0000-0002-5751-2010"
  - family-names: Barve
    given-names: Keya
    orcid: "https://orcid.org/0000-0003-3241-2117"
  - family-names: Baumler
    given-names: Colton
    orcid: "https://orcid.org/0000-0002-5926-7792"
  - family-names: Botvinnik
    given-names: Olga
    orcid: "https://orcid.org/0000-0003-4412-7970"
  - family-names: Brooks
    given-names: Phillip
    orcid: "https://orcid.org/0000-0003-3987-244X"
  - family-names: Dsouza
    given-names: Daniel
    orcid: "https://orcid.org/0000-0001-7843-8596"
  - family-names: Gautier
    given-names: Laurent
    orcid: "https://orcid.org/0000-0003-0638-3391"
  - family-names: Hera
    given-names: Mahmudur Rahman
    orcid: "https://orcid.org/0000-0002-5992-9012"
  - family-names: Houts
    given-names: Hannah Eve
    orcid: "https://orcid.org/0000-0002-7954-4793"
  - family-names: Johnson
    given-names: Lisa K.
    orcid: "https://orcid.org/0000-0002-3600-7218"
  - family-names: Klötzl
    given-names: Fabian
    orcid: "https://orcid.org/0000-0002-6930-0592"
  - family-names: Koslicki
    given-names: David
    orcid: "https://orcid.org/0000-0002-0640-954X"
  - family-names: Lim
    given-names: Marisa
    orcid: "https://orcid.org/0000-0003-2097-8818"
  - family-names: Lim
    given-names: Ricky
    orcid: "https://orcid.org/0000-0003-1313-7076"
  - family-names: Nelson
    given-names: Bradley
    orcid: "https://orcid.org/0009-0001-1553-932X"
  - family-names: Ogasawara
    given-names: Ivan
    orcid: "https://orcid.org/0000-0001-5049-4289"
  - family-names: Reiter
    given-names: Taylor
    orcid: "https://orcid.org/0000-0002-7388-421X"
  - family-names: Scott
    given-names: Camille
    orcid: "https://orcid.org/0000-0001-8822-8779"
  - family-names: Sjödin
    given-names: Andreas
    orcid: "https://orcid.org/0000-0001-5350-4219"
  - family-names: Standage
    given-names: Daniel
    orcid: "https://orcid.org/0000-0003-0342-8531"
  - family-names: Swamidass
    given-names: S. Joshua
    orcid: "https://orcid.org/0000-0003-2191-0778"
  - family-names: Tiffany
    given-names: Connor
    orcid: "https://orcid.org/0000-0001-8188-7720"
  - family-names: Vemuri
    given-names: Pranathi
    orcid: "https://orcid.org/0000-0002-5748-9594"
  - family-names: Young
    given-names: Erik
    orcid: "https://orcid.org/0000-0002-9195-9801"
  - family-names: Brown
    given-names: C. Titus
    orcid: "https://orcid.org/0000-0001-6001-2677"
  date-published: 2024-06-28
  doi: 10.21105/joss.06830
  issn: 2475-9066
  issue: 98
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6830
  title: "sourmash v4: A multitool to quickly search, compare, and
    analyze genomic and metagenomic data sets"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06830"
  volume: 9
title: "sourmash v4: A multitool to quickly search, compare, and analyze
  genomic and metagenomic data sets"

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.06830 joss-papers#5547
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06830
  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 Jun 28, 2024
@Kevin-Mattheus-Moerman
Copy link
Member

@bluegenes congratulations on this JOSS publication!

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

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

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

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:

@bluegenes
Copy link

Thank you @Kevin-Mattheus-Moerman!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted C published Papers published in JOSS pyOpenSci Submissions associated with pyOpenSci Python recommend-accept Papers recommended for acceptance in JOSS. review Rust Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials
Projects
None yet
Development

No branches or pull requests

7 participants