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.1.tar.gz (29.8 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.1-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyclustree-0.4.1.tar.gz
Algorithm Hash digest
SHA256 a8b6fa896483605b900d89c135e67a12cd9f0b3dd9f88787a2fda1787b0b8b6b
MD5 03e57ed5f3e9d50bac7770976f91f9fc
BLAKE2b-256 0ab999eaa0f093f0fa495399fe22b976fa0d6c09902fe9822ac8131720d41165

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyclustree-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 740893e4848edc050f4136a5d14096c73ac4949fe067e733de2c506c1b032cf1
MD5 7f3b8899404db22a07fd4ffdc828f9fa
BLAKE2b-256 6d400bef85f25b05805adcfb5bd92e7ad41ae95539ca469effea78477b91a836

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