Skip to main content

Visualize cluster assignments at different resolutions

Project description

pyclustree

Version License GitHub Actions Workflow Status Documentation Status Codecov Python Version Required DOI

Visualize cluster assignments at different resolutions. Possbile applications include finding the optimal resolution for single-cell RNA-sequencing clusterings.

pyclustree is inspired by the R package clustree (Github repository), however, while we aim to provide the same functionality, the API will differ between the implementations.

Getting started

Please refer to the documentation.

Installation

You need to have Python 3.10 or newer installed on your system. If you don't have Python installed, we recommend installing Mambaforge.

There are several alternative options to install pyclustree:

  1. Install the latest release of pyclustree from PyPI:
pip install pyclustree
  1. Install the latest development version:
pip install git+https://github.com/complextissue/pyclustree.git@dev

Contact

If you found a bug, please use the issue tracker.

Authors

@maltekuehl @harryhaller001

Unaffiliated with the creators of the R package clustree.

License

Please refer to the LICENSE file.

Citation

Please cite both the original R package as well as this implementation when using pyclustree. For example: Cluster resolution was determined based on visualization with pyclustree (Kuehl et al., 2024), a Python implementation of clustree (Zappia et al., 2018).

  • pyclustree: Kuehl, M., Hellmig, M., & Puelles, V. G. (2024). pyclustree: Visualizing cluster resolution optimization for biomedical data (0.3.1). Zenodo. https://doi.org/10.5281/zenodo.13987570
  • clustree: Zappia, L., & Oshlack, A. (2018). Clustering trees: a visualization for evaluating clusterings at multiple resolutions. Gigascience, 7(7), giy083.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyclustree-0.4.0.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyclustree-0.4.0-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file pyclustree-0.4.0.tar.gz.

File metadata

  • Download URL: pyclustree-0.4.0.tar.gz
  • Upload date:
  • Size: 30.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for pyclustree-0.4.0.tar.gz
Algorithm Hash digest
SHA256 5145ebb56c4b2227435a76581e5e974fd12e7618955126ca6051cf258d321e3d
MD5 e8007a3089bda53a577d3833c8c6968d
BLAKE2b-256 93410365d08859043a27e23e8247b2ef9bb8d4d049268158e7cb4bb98c1a98ef

See more details on using hashes here.

File details

Details for the file pyclustree-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: pyclustree-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for pyclustree-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff56bb57973799294d69b159880d23e2947dc35a2de43d087ece45b10dcc97b2
MD5 e0b34000662e6947be31df2f59e3fe0a
BLAKE2b-256 e469bb1f83bb942631cf3979f921390641cf65d0fcd85b09787011724dc59668

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page