|
4 | 4 | [![Coverage][badge-coverage]][coverage] |
5 | 5 | [![Documentation][badge-docs]][documentation] |
6 | 6 | [![Pre-commit.ci][badge-pre-commit]][pre-commit] |
| 7 | +[![PyPI][badge-pypi]][pypi] |
7 | 8 |
|
8 | 9 | [badge-tests]: https://img.shields.io/github/actions/workflow/status/quadbio/cell-annotator/test.yaml?branch=main |
9 | 10 | [badge-coverage]: https://codecov.io/gh/quadbio/cell-annotator/branch/main/graph/badge.svg |
10 | 11 | [badge-docs]: https://img.shields.io/readthedocs/cell-annotator |
11 | 12 | [badge-pre-commit]: https://results.pre-commit.ci/badge/github/quadbio/cell-annotator/main.svg |
| 13 | +[badge-pypi]: https://img.shields.io/pypi/v/cell-annotator.svg |
12 | 14 |
|
13 | 15 | A tool to annotate cell types in scRNA-seq data based on marker genes using OpenAI models. |
14 | 16 |
|
15 | 17 | ## Key features |
16 | 18 |
|
17 | | -- Automatically annotate cells including type, state and confidence fields. |
18 | | -- Generate consistent annotations across samples of your study. |
19 | | -- Optionally infuse prior knowledge by providing information about your biological system. |
20 | | -- Retrieve reliable results thanks to [OpenAI structured outputs](https://platform.openai.com/docs/guides/structured-outputs) |
21 | | -- Use this tool to quickly generate pre-integration cell type labels to either score your integration quality (e.g. [scIB metrics](https://scib-metrics.readthedocs.io/en/stable/)) or to guide your integration effort (e.g. [scPoli](https://docs.scarches.org/en/latest/), [scANVI](https://docs.scvi-tools.org/en/stable/api/reference/scvi.model.SCANVI.html)). |
| 19 | +- Automatically annotate cells including type, state and confidence fields. |
| 20 | +- Generate consistent annotations across samples of your study. |
| 21 | +- Optionally infuse prior knowledge by providing information about your biological system. |
| 22 | +- Retrieve reliable results thanks to [OpenAI structured outputs](https://platform.openai.com/docs/guides/structured-outputs) |
| 23 | +- Use this tool to quickly generate pre-integration cell type labels to either score your integration quality (e.g. [scIB metrics](https://scib-metrics.readthedocs.io/en/stable/)) or to guide your integration effort (e.g. [scPoli](https://docs.scarches.org/en/latest/), [scANVI](https://docs.scvi-tools.org/en/stable/api/reference/scvi.model.SCANVI.html)). |
| 24 | + |
| 25 | +Note that this package is based on output generated by large language models and might **sometimes make mistakes**. We use some safeguards, like anchoring the tool in a multi-step process, and using structured output predictions, but mistakes are still possible. We recommend using this tool as a first step in an annotation workflow to generate an initial, coarse set of annotations that must be further refined. |
22 | 26 |
|
23 | 27 | ## Installation |
24 | 28 |
|
@@ -73,3 +77,4 @@ If you found a bug, please use the [issue tracker][]. |
73 | 77 | [coverage]: https://codecov.io/gh/quadbio/cell-annotator |
74 | 78 | [documentation]: https://cell-annotator.readthedocs.io |
75 | 79 | [pre-commit]: https://results.pre-commit.ci/latest/github/quadbio/cell-annotator/main |
| 80 | +[pypi]: https://pypi.org/project/cell-annotator/ |
0 commit comments