Metadata-Version: 2.1
Name: mheatmap
Version: 1.2.0
Summary: A package for mosaic/proportional heatmap visualization and matrix analysis
Home-page: https://github.com/qqgjyx/mheatmap
Author: Juntang Wang
Author-email: jw853@duke.edu
Project-URL: Bug Tracker, https://github.com/qqgjyx/mheatmap/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: seaborn
Requires-Dist: scipy
Requires-Dist: scikit-learn

# <img src="docs/assets/mheatmap.png" width="40px" align="center" alt="mheatmap logo"> mheatmap

[![PyPI version](https://badge.fury.io/py/mheatmap.svg)](https://badge.fury.io/py/mheatmap)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Python package for advanced heatmap visualization and matrix analysis,
featuring mosaic/proportional heatmaps, confusion matrix post-processing,
and spectral reordering capabilities.

---

## 📋 Table of Contents

1. [🚀 Features](#-features)
2. [📦 Installation](#-installation)
    - [Install from PyPI](#install-from-pypi)
    - [Install from Source](#install-from-source)
3. [📘 Documentation](#-documentation)
4. [📚 Examples](#-examples)
5. [🛠 Contributing](#-contributing)
6. [📝 License](#-license)

---

## 🚀 Features

- **Mosaic Heatmap**  
  Visualize matrix values with proportionally-sized cells.  
  ![Comparison between normal and mosaic heatmap](docs/examples/images/basic_mosaic_heatmap.png)

- **Automatic Model Calibration (AMC)**  
  Align, Mask, and Confusion—an algorithm for post-processing confusion matrices.

- **Spectral Reordering**  
  Reorder matrices based on spectral analysis.
  ![Spectral reordering example](docs/examples/images/spectral_permutation.png)

- **RMS (Reverse Merge/Split) Analysis**  
  Perform advanced permutation analysis to explore matrix structures.  
  ![RMS permutation example](docs/examples/images/rms_permutation.png)

---

## 📦 Installation

### Install from PyPI

```bash
pip install mheatmap
```

### Install from source

```bash
git clone https://github.com/qqgjyx/mheatmap.git
cd mheatmap
pip install .
```

## 📘 Documentation

Comprehensive documentation is available [here](https://www.qqgjyx.com/mheatmap).

## 📚 Examples

See [Examples](docs/examples) for more detailed examples.

## 🛠 Contributing

We welcome contributions to improve mheatmap! Please follow these steps:

1. Fork the repository
2. Create a new branch (`feature-branch`)
3. Commit your changes
4. Open a pull request

## 📝 License

This project is licensed under the MIT License.
See the [LICENSE](LICENSE) file for details.
