Sankey Plots

Sankey plots (often called Sankey diagrams) can be generated using the fig_sankey() function, which returns a Plotly Go Figure object.

The plot below was generated using a synthetic dataset for a hypothetical community of 1200 people who are hospitalised.

The dataset is given below as a table (but can also be loaded from the docs/sources/plot-gallery/examples/csv/sankey.csv file).

Disease outbreak response in a small community

Source	Target	Value
Community	Hospitalised	1200
Hospitalised	ICU	300
Hospitalised	Ward	900
ICU	Death	80
ICU	Recovered	220
Ward	Recovered	850
Ward	Death	50

Here are the Python steps you need to generate the plot using the fig_sankey() function:

import pandas as pd
from isaricanalytics.visualisation import fig_sankey

# Load the CSV
data = pd.read_csv("./csv/sankey.csv")

# Create the labels, nodes, flows/arrows and annotations
labels = pd.Series(pd.unique(data[["source", "target"]].values.ravel()))
nodes = pd.DataFrame({
   "label": labels,
   "customdata": labels.apply(lambda x: f"{x} (synthetic)")
})
label_to_idx = {label: i for i, label in enumerate(labels)}
arrows = pd.DataFrame({
   "source": data["source"].map(label_to_idx),
   "target": data["target"].map(label_to_idx),
   "value": data["value"],
   "customdata": data.apply(lambda r: f"{r['source']} → {r['target']}: {r['value']} cases", axis=1)
})
annotations = pd.DataFrame([{
   "text": "Sankey plot of Synthetic Outbreak Patient Case Flow",
   "x": 0.5,
   "y": 1.08,
   "xref": "paper",
   "yref": "paper",
   "showarrow": False,
   "font": {"size": 14}
}])

fig = fig_sankey(
    [nodes, arrows, annotations],
)
fig.update_layout(autosize=True)
fig

Note

Any dataframe or CSV column names, or dictionary field labels, in the example above that are not specific to the dataset must be as given, otherwise the function may throw an exception or return an incorrect figure.

The figure height and width parameters can be set using the height and width parameters, but it may be more convenient to let Plotly handle this using the figure layout autosize parameter. Refer to the fig_sankey() function docstring for more information.