mapQC
A metric for the evaluation of single-cell query-to-reference mappings
Getting started
Please refer to the documentation, in particular, the API documentation for detailed package documentation. For reproduction of the results in the paper, check out the mapQC reproducibility repository.
Below a few notes on how and when to use mapQC:
What does mapQC do?
MapQC evaluates the quality of a query-to-reference mapping, and outputs a cell-level mapQC score for every query cell. MapQC scores higher than 2 indicate a large distance of the query cell to the reference. Given a healthy/control reference, we expect query controls to have low mapQC scores, and query case/disease cells to have higher mapQC scores in the case of case-specific cellular phenotypes. You can thus use mapQC scores to assess, in a quantitative manner, if your mapping was successful.
Overview of mapQC's workflow
What are the data requirements for using mapQC?
In short, you need one AnnData object, including:
- A large scale reference, including only its healthy/control cells.
- A mapped query dataset, with healthy/control cells (must-have) and case/perturbed cells (if you have them).
- Metadata (query/reference status, study, sample, and optionally clustering and cell type annotations)
- A mapping-derived embedding including both the reference and the query
In the quick-start tutorial notebook we provide a more extensive description of the exact data requirements.
Installation
You need to have Python 3.10 or newer installed on your system.
There are several alternative options to install mapQC:
- Install the latest release of
mapqcfrom PyPI:
pip install mapqc
- Install the latest development version:
pip install git+https://github.com/theislab/mapqc.git@main
Release notes
See the changelog.
Contact
I am happy to hear any comments, suggestions, or even bugs that you run into. I would like to make this package run as smoothly as possible! So for any of these, submit an issue on the mapQC GitHub page and I will be glad to help.
Citation
Sikkema et al., bioRxiv 2025.
Metadata
Release files for mapqc 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mapqc-0.1.1.tar.gz | 15.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mapqc-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.2 MB
Release files / mapqc-0.1.1.tar.gz
| Download URL | mapqc-0.1.1.tar.gz |
|---|---|
| Size | 15.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
10d10f2c3361286cdedee22370ffd5caff52c831aff37ac5e94a2510bf194dff
|
|
BLAKE2b-256 checksum How to use checksums |
7f59e313d9ef9bb7e5048fd3fcda22b1f9c0881811ac28aac2347d4d25b0d936
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 17, 2025.
Transparency logRelease files / mapqc-0.1.1-py3-none-any.whl
| Download URL | mapqc-0.1.1-py3-none-any.whl |
|---|---|
| Size | 40.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dba09a8a1efded58a49f669df44ce056398f8249f6c8699b2b1f2c9df7158a7f
|
|
BLAKE2b-256 checksum How to use checksums |
5854c10575d657ccf6a067104e18cd0cb1187c8bb469aa604b1435a846f33651
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 17, 2025.
Transparency log