https://github.com/dmalzl/pylluvial

A python library for creating alluvial diagrams
https://github.com/dmalzl/pylluvial

Last synced: about 1 month ago
JSON representation

A python library for creating alluvial diagrams

• Host: GitHub
• URL: https://github.com/dmalzl/pylluvial
• Owner: dmalzl
• License: mit
• Created: 2022-07-21T10:59:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-23T15:15:10.000Z (about 1 year ago)
• Last Synced: 2024-04-24T15:19:31.677Z (9 months ago)
• Language: Python
• Size: 737 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pylluvial

![pypi](https://img.shields.io/badge/pypi-v1.1.1-blue)

![python-version](https://img.shields.io/badge/Python->=3.9-blue)

![stable-version](https://img.shields.io/badge/version-1.1.1-blue)

A python library for creating alluvial diagrams with an arbitrary number of layers

## Installation

Simply run the following

```commandline

pip install pylluvial

```

or clone the repository 

```commandline

git clone [email protected]:dmalzl/pylluvial.git

```

and run

```commandline

cd pylluvial

pip install .

```

you should then be able to import the package as usual

## Usage

A minimal usage example would be as follows

```python

import pylluvial as pa

data = pa.generate_test_data(

    [3, 4, 3, 2]

)

# by default labels are not shown

fig, ax = pa.alluvial(

    x='timepoint',

    stratum='module',

    alluvium='nodename',

    data=data,

    palette='husl',

    stratum_gap=2,

    stratum_width=2

)

fig.set_figwidth(10)

fig.set_figheight(5)

fig.tight_layout()

```

![](/example/without_labels.png)

```python

# pass show_labels = True to get labelled plots

fig, ax = pa.alluvial(

    x = 'timepoint',

    stratum = 'module',

    alluvium = 'nodename',

    palette = 'husl',

    data = data,

    stratum_gap = 2,

    stratum_width = 2,

    show_labels = True

)

fig.set_figwidth(10)

fig.set_figheight(5)

fig.tight_layout()

```

![](/example/with_labels.png)

```python

# use hue to split strata by a given grouping variable

fig, ax = pa.alluvial(

    x = 'timepoint',

    stratum = 'module',

    alluvium = 'nodename',

    hue = 'signif',

    palette = 'tab20',

    data = data,

    stratum_gap = 2,

    stratum_width = 2,

    show_labels = True

)

fig.set_figwidth(10)

fig.set_figheight(5)

fig.tight_layout()

```

![](/example/with_hue.png)

The color assignment for hue elements using string arguments for palette can be quite cumbersome.

However, you can always pass a dictionary with the colors you want to use to palette instead of a string

```python

tab20_colors = {

    '1_s': '#1F77B5',

    '1_ns': '#B0C6E8',

    '2_s': '#F07E21',

    '2_ns': '#F9BA79',

    '3_s': '#2AA137',

    '3_ns': '#9DCB88',

    '4_s': '#D62828',

    '4_ns': '#F29697'

}

colors = {

    f't{i}': tab20_colors for i in range(4)

}

fig, ax = pa.alluvial(

    x = 'timepoint',

    stratum = 'module',

    alluvium = 'nodename',

    hue = 'signif',

    palette = colors,

    data = data,

    stratum_gap = 2,

    stratum_width = 2,

    show_labels = True

)

```