sourmash plugin for improved plotting/viz and cluster examination.
Project description
sourmash_plugin_betterplot
What is this?
sourmash compare
and
sourmash plot
produce basic distance matrix plots that are useful for comparing and
visualizing the relationships between dozens to hundreds of
genomes. And this is one of the most popular use cases for sourmash!
But! The visualization could be improved a lot beyond the basic viz
that sourmash plot
produces, and there are a lot of only slightly
more complicated use cases for comparing, clustering, and visualizing
many genomes!
This plugin will explore these use cases!
Specific goals:
- provide a variety of plotting and exploration commands that can be used with sourmash tools;
- provide both command-line functionality and functions that can be imported and used in Jupyter notebooks;
- (maybe) explore other backends than matplotlib;
and who knows what else??
Installation
pip install sourmash_plugin_betterplot
Usage
@CTB: info goes here!
Examples
sourmash scripts plot2 3sketches.cmp -o examples/plot2.3sketches.cmp.png
yields:
Support
We suggest filing issues in the main sourmash issue tracker as that receives more attention!
Dev docs
betterplot
is developed at https://github.com/sourmash-bio/sourmash_plugin_betterplot.
Testing
Run:
pytest tests
Generating a release
Bump version number in pyproject.toml
and push.
Make a new release on github.
Then pull, and:
python -m build
followed by twine upload dist/...
.
CTB May 2024
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sourmash_plugin_betterplot-0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b404fbe7961fc08685fb645d4234a95a54d3e84f7c2e4eb14b6823602ca2958 |
|
MD5 | af637191636d63744986d6002191f871 |
|
BLAKE2b-256 | 2de1b3953f01a841503076ffdf17f71e5a859cbc96517090eea760b8afdf83e7 |
Hashes for sourmash_plugin_betterplot-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57ab0d5379bdbd143a6fb66c1147bd22a4fa2cb7bbf95864c190cafaae2720e9 |
|
MD5 | 8cd1fe23dedadfc79f8e998c06ab2dfb |
|
BLAKE2b-256 | f717509888ef26e8fbad11cfb446cbf9b14e7a36f33160bcc4ff738580f624b0 |