onstove.MCA.plot_share#

MCA.plot_share(index: str = 'clean cooking potential index', layer: tuple[str, str] = ('demand', 'population'), title: str = 'Clean Cooking Potential Index', output_file: str | None = None)[source]#

Creates a pie chart showing five different classes of the index categorized from low to high.

Parameters:

index: str, default ``clean cooking potential index``: Index to plot the share for.
layer: tuple of two str pairs, ``(‘demand’, ‘population’)``: Category and layer name for the layer to use to calculate the shares. If ('demand', 'population') then the population shares falling on each of the five categories is shown in the pie chart.
title: str, default ``’Clean Cooking Potential Index’``: Title of the plot.
output_file: str, optional: File name used to save the plot into the output_directory. If None, then the plot is not saved, only returned

Returns:

matplotlib.axes.Axes: The axes of the figure.