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

Add PILOT #189

Merged
merged 3 commits into from
Aug 13, 2024
Merged

Add PILOT #189

merged 3 commits into from
Aug 13, 2024

Conversation

mehdijoodaki
Copy link
Contributor

Checklist

  • Name of the tool: PILOT
  • Short description: PILOT is a Python library for Detection of PatIent-Level distances from single cell genomics and pathomics data with Optimal Transport.Transport (PILOT)
  • How does the package use scverse data structures (please describe in a few sentences): PILOT utilizes AnnData for single-cell data representation and processing.
  • The code is publicly available under an OSI-approved license
  • The package provides versioned releases
  • The package can be installed from a standard registry (e.g. PyPI, conda-forge, bioconda)
  • The package uses automated software tests and runs them via continuous integration (CI)
  • The package provides API documentation via a website or README
  • The package uses scverse datastructures where appropriate (i.e. AnnData, MuData or SpatialData and their modality-specific extensions)
  • I am an author or maintainer of the tool and agree on listing the package on the scverse website

@grst
Copy link
Contributor

grst commented Jul 22, 2024

Hi @mehdijoodaki,

thanks for submitting! This is certainly a cool method and I like the detailled tutorials you have on your website.
I have a couple of comments regading the checklist that would need to be addressed before we can merge this:

The package provides API documentation via a website or README

I have seen you list function parameters for some of your functions in your tutorial, but what we mean by "API documentation" as a full overview of all (public) functions and their parameters, e.g https://scirpy.scverse.org/en/latest/api.html. There are sphinx plugins to generate such a page easily.

The package uses automated software tests and runs them via continuous integration (CI)

I don't think the repo has continuous integration, e.g. using github actions? You can find an example in our cookiecutter template: https://github.com/scverse/cookiecutter-scverse/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/.github/workflows/test.yaml

The tests are also very minimal - while we don't have strict requirements on the test coverage at the moment, it would be good to test all public functions. At the very least to make sure they don't fail on example data, even better would be to also test their correctness, e.g. by running them on toy data with known expected results or by comparing against snapshots of the results run on example data.

@mehdijoodaki
Copy link
Contributor Author

Hi @grst
Thanks for the helpful comments, I have fixed the requested changes, could you please look into it?
Thanks

Copy link
Contributor

@grst grst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay, this LGTM now!

@grst grst merged commit 45dac56 into scverse:main Aug 13, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants