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 celltypist #182

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add celltypist #182

wants to merge 1 commit into from

Conversation

ChuanXu1
Copy link

@ChuanXu1 ChuanXu1 commented Jul 6, 2024

Mandatory

Name of the tool: celltypist

Short description: CellTypist is an automated cell type annotation tool for scRNA-seq datasets.

How does the package use scverse data structures (please describe in a few sentences): CellTypist uses anndata for most analyses and is dependent on Scanpy.

  • 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

Recommended

  • Please announce this package on scverse communication channels (zulip, discourse, twitter)
  • Please tag the author(s) these announcements. Handles (e.g. @scverse_team) to include are:
    • Twitter:
    • Zulip:
    • Discourse:
    • Mastodon:
  • The package provides tutorials (or "vignettes") that help getting users started quickly
  • The package uses the scverse cookiecutter template.

@grst
Copy link
Contributor

grst commented Jul 8, 2024

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

I can't find any tests nor continous integration in the repo or am I overlooking something?
The rest is fine!

For a test/CI setup, you can check out how it's done in our cookiecutter template.
The probably lowest hanging fruit for test-cases are high-level "smoke tests", i.e. you just test the public interface on a test dataset and compare the results against a snapshot. Additionally lower level "unit test" could be implemented that test individual functions, including internal ones. Just having the former would be ok from our side, we mainly just want to make sure that there's an automated way to detect if something breaks.

@ChuanXu1
Copy link
Author

ChuanXu1 commented Jul 8, 2024

I see. Will incorporate this and inform you then :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants