Skip to content

README.md

Latest commit

 

History

History
80 lines (54 loc) · 2.14 KB

README.md

File metadata and controls

80 lines (54 loc) · 2.14 KB

mheatmap logo mheatmap

PyPI version License: 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
  2. 📦 Installation
  3. 📘 Documentation
  4. 📚 Examples
  5. 🛠 Contributing
  6. 📝 License

🚀 Features

  • Mosaic Heatmap
    Visualize matrix values with proportionally-sized cells.
    Comparison between normal and mosaic heatmap

  • 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

  • RMS (Reverse Merge/Split) Analysis
    Perform advanced permutation analysis to explore matrix structures.
    RMS permutation example

📦 Installation

Install from PyPI

pip install mheatmap

Install from source

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

📘 Documentation

Comprehensive documentation is available here.

📚 Examples

See 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 file for details.