opticlust
Single cell clustering and recommendations at a glance. Identify which clustering resolution(s) fit your data within minutes.
Opticlust currently offers:
- Automated clustering (leiden/louvain) at various resolutions
- Automatic selection of significant resolutions
- Clustering recommendations based on intra- and intercluster metrics
- Visualization of clusters per resolution and their relative compositions
- Easy to use, yet highly customizable Python API
- Cluster recoloring for opticlust and UMAP visualization (see below)
Installation
PyPi
pip install opticlust
Conda
conda install -c bioconda opticlust
GitHub
git clone https://github.com/siebrenf/opticlust.git
pip install opticlust
Develop
git clone https://github.com/siebrenf/opticlust.git
conda env create -n opticlust -f opticlust/requirements.yaml
conda activate opticlust
pip install --editable ./opticlust --no-deps --ignore-installed
Tutorial output
Output of clustering_plot() and score_resolutions():
Output of clustree():
Output of sc.pl.umap()
Output of sc.pl.rank_genes_groups_heatmap() and sc.pl.rank_genes_groups_dotplot():
top_low recommended resolution:
top_medium recommended resolution:
top_high recommended resolution:
Advantages of opticlust
The UMAPs and cluster tree plot can be compared immediately due to the automatic renaming and recoloring of the clusters. Without renaming and recoloring, figures would have looked like this:
Output of clustree(rename_cluster=False) and sc.pl.umap():
Note how cluster 2 becomes cluster 3 at resolution 0.43. This makes it difficult to track how changes in resolution impacted the clustering.
Acknowledgements
This tool was inspired by:
- The original Clustree R package.
- This BioStars post by firestar.
How to cite
When using this software package, please cite the accompanied DOI under "Citation" at https://doi.org/10.5281/zenodo.14513541
Metadata
Release files for opticlust 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| opticlust-0.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / opticlust-0.5.0-py3-none-any.whl
| Download URL | opticlust-0.5.0-py3-none-any.whl |
|---|---|
| Size | 38.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b7872589c63a6ca7d53da181abb432b1b70456a780dd62d7a1181d615555e6a0
|
|
BLAKE2b-256 checksum How to use checksums |
0299b02abe2110d1aa5576a0333439d8cdbd697b712832ece1f2f6c26c941657
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for opticlust 0.5.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.