.. funkyheatmappy documentation master file, created by
   sphinx-quickstart on Mon Nov  4 17:37:19 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Funkyheatmappy
==============

{funkyheatmap} allows generating heatmap-like visualisations for benchmark data frames. 
Funky heatmaps can be fine-tuned by providing annotations of the columns and rows, 
which allows assigning multiple palettes or geometries or grouping rows and columns 
together in categories.

This package is a Python-based implementation of the `{funkyheatmap} <https://github.com/funkyheatmap/funkyheatmap>`_ package.

Installation
------------
To install the package, run the following command:

.. code-block:: console

      $ pip install git+https://github.com/funkyheatmap/funkyheatmappy

Usage
-----
To use the package, import the `funkyheatmappy` module and call the `funkyheatmap` function.

Documentation about the API can be found `here <autoapi/funkyheatmappy/index.html>`_.
An example of the usage of the package can be found `here <mtcars.html>`_.

Contributing
------------
Do not hesitate to open an issue or a pull request if you have any suggestions or if you find any bugs.

You are free to contact the authors for any questions or collaborations, at the following email addresses:
artuur_couckuyt@hotmail.be & louise.deconinck@gmail.com.


Navigation
==========

.. toctree::
   :maxdepth: 2

   index