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]: anndata: Access and store annotated data matrices #4371

Closed
editorialbot opened this issue May 4, 2022 · 149 comments
Closed

[REVIEW]: anndata: Access and store annotated data matrices #4371

editorialbot opened this issue May 4, 2022 · 149 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented May 4, 2022

Submitting author: @falexwolf (F. Alexander Wolf)
Repository: https://github.com/scverse/anndata
Branch with paper.md (empty if default branch): paper
Version: 0.10.9
Editor: @luizirber
Reviewers: @nlhepler, @rcannood
Archive: 10.5281/zenodo.13643180

Status

status

Status badge code:

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

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

@nlhepler & @rcannood, 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 @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

Checklists

📝 Checklist for @nlhepler

📝 Checklist for @rcannood

@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

Checking the BibTeX entries failed with the following error:

No paper file path

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.17 s (629.4 files/s, 102055.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          65           2795           2286          10220
reStructuredText                29            271            228            574
YAML                             5             19              2            129
TOML                             1              8              4            110
make                             1              5              6             14
Jupyter Notebook                 1              0            171             12
Markdown                         1              3              0              6
SVG                              1              0              0              1
-------------------------------------------------------------------------------
SUM:                           104           3101           2697          11066
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Failed to discover a Statement of need section in paper

@editorialbot
Copy link
Collaborator Author

⚠️ An error happened when generating the pdf. Paper file not found.

@nlhepler
Copy link

nlhepler commented May 4, 2022

Review checklist for @nlhepler

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/theislab/anndata?
  • 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 (@falexwolf) 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?

@rcannood
Copy link

rcannood commented May 4, 2022

Review checklist for @rcannood

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/theislab/anndata?
  • 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 (@falexwolf) 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?

@luizirber
Copy link

@editorialbot set paper as branch

@editorialbot
Copy link
Collaborator Author

Done! branch is now paper

@luizirber
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@arfon
Copy link
Member

arfon commented Jun 17, 2022

👋 @nlhepler – how are you getting along with your review here?

@falexwolf
Copy link

@arfon We moved the repository from theislab/anndata to https://github.com/scverse/anndata. Could you update the metadata here?

@nlhepler
Copy link

@arfon apologies for the delay. I aim to have it done today, certainly no later than tomorrow.

@falexwolf
Copy link

Let me try to generate an up-to-date version that includes our response to @rcannood:

@editorialbot generate pdf

@danielskatz
Copy link

editorialbot commands need to be the first entry in a new comment.

@falexwolf
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@nlhepler
Copy link

@falexwolf, I see that @rcannood has opened scverse/anndata#769, would you prefer I piggy-back my comments there or open a separate issue?

@falexwolf
Copy link

Thanks for checking! It'd be great if you added your comments to the existing thread! It's more efficient if we address both of your comments in ideally one additional pass on the paper (or as many it takes until your happy)! 😅

@arfon
Copy link
Member

arfon commented Aug 5, 2022

👋 folks. Just checking how things are going here? @nlhepler, @rcannood – it looks like you're well on your way to completing your reviews, have you had a chance to provide all of your feedback to @falexwolf?

@nlhepler
Copy link

nlhepler commented Aug 5, 2022

👋 Hi @arfon, the conversation is mostly happening in scverse/anndata#769 -- we're still going back and forth

@falexwolf
Copy link

Yes, all reviews are there! Isaac was on a several-week-long conference and holiday trip.

He just got back last week and we want to get back to reviews this Monday.

@editorialbot editorialbot added the Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials label Sep 10, 2022
@arfon
Copy link
Member

arfon commented Oct 1, 2022

👋 folks. Just checking in again here – @nlhepler, @rcannood – are your reviews mostly complete?

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot set 0.10.9 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now 0.10.9

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot check references

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.1186/s13059-017-1382-0 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.1038/nmeth.3252 is OK
- 10.5281/zenodo.264282 is OK
- 10.48550/arXiv.1309.0238 is OK
- 10.1016/j.cell.2021.04.048 is OK
- 10.21105/joss.03021 is OK
- 10.25080/majora-92bf1922-00a is OK
- 10.1007/bf02985802 is OK
- 10.1101/2021.02.19.431994 is OK
- 10.1101/2021.04.05.438318 is OK
- 10.1101/2021.04.28.441833 is OK
- 10.1038/s41587-020-0591-3 is OK
- 10.1101/2021.06.01.445670 is OK
- 10.1158/0008-5472.can-17-0344 is OK
- 10.5281/zenodo.3773450 is OK
- 10.18129/B9.bioc.tidySummarizedExperiment is OK
- 10.48550/arXiv.1802.03426 is OK
- 10.1038/s41592-019-0654-x is OK
- 10.48550/arXiv.1912.01703 is OK
- 10.1101/2023.12.11.23299816 is OK
- 10.1186/s13059-021-02519-4 is OK
- 10.14778/3025111.3025117 is OK
- 10.1038/s41586-019-1629-x is OK
- 10.7554/eLife.27041 is OK
- 10.32614/cran.package.anndata is OK
- 10.18129/B9.bioc.zellkonverter is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Scikit-learn: Machine Learning in Python
- No DOI given, and none found for title: Machine Learning: A Probabalistic Perspective
- No DOI given, and none found for title: Tidy data
- No DOI given, and none found for title: Python and HDF5
- No DOI given, and none found for title: The relational model for database management: vers...
- No DOI given, and none found for title: airspeed velocity
- No DOI given, and none found for title: A sandbox for prediction and integration of DNA, R...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

@Kevin-Mattheus-Moerman
Copy link
Member

@openjournals/dev can you help with this paper compilation error? It seems to be related to affiliations but I can't quite make out what is wrong. Thanks

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Sep 5, 2024

@falexwolf

  • Can you please edit the archive listed license to be 0.10.9, it currently says v2. There is no need to create a new archive link any more at this point, you can manually edit the listing and version tag.

@danielskatz
Copy link

This isn't the issue with compiling, but looking at the affiliations, they should all have the final period "." removed, and have the country added. The period at the end of the note for Wolf should also be removed.

@falexwolf
Copy link

Can you please edit the archive listed license to be 0.10.9, it currently says v2. There is no need to create a new archive link any more at this point, you can manually edit the listing and version tag.

Done!

This isn't the issue with compiling, but looking at the affiliations, they should all have the final period "." removed, and have the country added. The period at the end of the note for Wolf should also be removed.

I'll try this right away.

@falexwolf
Copy link

Removed the periods and added the countries: scverse/anndata@4ca388a

@danielskatz
Copy link

@Kevin-Mattheus-Moerman - the problem might be related to openjournals/joss#1353

@rcannood
Copy link

rcannood commented Sep 6, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@rcannood
Copy link

rcannood commented Sep 8, 2024

@Kevin-Mattheus-Moerman Does the proof look good to you?

@Kevin-Mattheus-Moerman
Copy link
Member

@rcannood thanks for your help with this review. I'll pick this up shortly.

I was wondering, can you please re-confirm if you have anything that an outsider might perceive as a conflict of interest with this submission? You are not listed as an author, but do you actively work with the authors? I see you are a contributor to the project, was that during this review or before? Thanks.

@rcannood
Copy link

@Kevin-Mattheus-Moerman I'd say back in May 2022 when I first reviewed the publication, I did not have any COIs related to the manuscript. Back then, I had probably already talked to some of the manuscript authors via GitHub issues, but did not know any of the authors personally.

Since then, I have become an avid user of the package, and use it in a lot of my projects. I did not contribute to the conceptualisation, development, or maintenance of this package, other than my review and one minor contribution I made in Dec 2020 (See below).

My enthusiasm related to wanting this paper published comes from my general affinity towards OSS and by extension JOSS, and also my belief that anndata is a useful package and its publication deserves publication.

However, for full transparency, I did start development on an R package called laminlabs/laminr last month in for Lamin Labs, whose CEO is @falexwolf -- the submitter of this manuscript.

I hope this addresses any concerns you may have.

TL;DR: I did not at the time of the review, I suppose that I do now.


Additional information

In Dec 2020 I made a small open-source contribution (scverse/anndata#463) related to an issue that I was encountering (scverse/anndata#464).

This issue I encountered while creating an R package also called 'anndata' (CRAN) which exposes the Python interface to users via reticulate. This was developed fully by myself without input from the scverse organisation (dynverse/anndata).

I did end up creating scverse/anndataR in collaboration with other non-scverse members lazappi LouiseDck and mtmorgan. However, this work was started in April 2023 as part of the scverse hackathon in Heidelberg (https://scverse.org/events/2023_04_hackathon/), which is way past my initial review.

@Kevin-Mattheus-Moerman
Copy link
Member

@rcannood thanks for the clarification. Since the COI did not exist at the time of review we can accept this. However at this point it would be good to step down here, in terms of involvement, and let the authors handle queries and communication with me.

@Kevin-Mattheus-Moerman
Copy link
Member

@falexwolf I believe all is in order now, so we will now proceed to process this for acceptance. It was unfortunately that this was a much longer than usual review process. We apologies for any delays from our end.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@falexwolf
Copy link

@Kevin-Mattheus-Moerman, thank you for accepting the paper and not dropping this submission after such a long time. I apologize for the delays caused by me in the process.

@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: Virshup
  given-names: Isaac
  orcid: "https://orcid.org/0000-0002-1710-8945"
- family-names: Rybakov
  given-names: Sergei
  orcid: "https://orcid.org/0000-0002-4944-6586"
- family-names: Theis
  given-names: Fabian J.
  orcid: "https://orcid.org/0000-0002-2419-1943"
- family-names: Angerer
  given-names: Philipp
  orcid: "https://orcid.org/0000-0002-0369-2888"
- family-names: Wolf
  given-names: F. Alexander
  orcid: "https://orcid.org/0000-0002-8760-7838"
doi: 10.5281/zenodo.13643180
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Virshup
    given-names: Isaac
    orcid: "https://orcid.org/0000-0002-1710-8945"
  - family-names: Rybakov
    given-names: Sergei
    orcid: "https://orcid.org/0000-0002-4944-6586"
  - family-names: Theis
    given-names: Fabian J.
    orcid: "https://orcid.org/0000-0002-2419-1943"
  - family-names: Angerer
    given-names: Philipp
    orcid: "https://orcid.org/0000-0002-0369-2888"
  - family-names: Wolf
    given-names: F. Alexander
    orcid: "https://orcid.org/0000-0002-8760-7838"
  date-published: 2024-09-16
  doi: 10.21105/joss.04371
  issn: 2475-9066
  issue: 101
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 4371
  title: "anndata: Access and store annotated data matrices"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.04371"
  volume: 9
title: "anndata: Access and store annotated data matrices"

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

@falexwolf congratulations on this JOSS publication.

@luizirber thanks for editing!

And a special thank you to the reviewers: @nlhepler, @rcannood !!

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

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

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

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 Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials
Projects
None yet
Development

No branches or pull requests

9 participants