policyengine-core 2.3.0__tar.gz → 2.5.0__tar.gz

{policyengine-core-2.3.0/policyengine_core.egg-info → policyengine-core-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: policyengine-core
-Version: 2.3.0
+Version: 2.5.0
 Summary: Core microsimulation engine enabling country-specific policy models.
 Home-page: https://github.com/policyengine/policyengine-core
 Author: PolicyEngine

{policyengine-core-2.3.0 → policyengine-core-2.5.0}/policyengine_core/charts/__init__.py

@@ -1,8 +1,6 @@
 from .formatting import (
-    DARK_BLUE,
     BLUE,
-    LIGHT_BLUE,
-    LIGHTER_BLUE,
+    BLUE_COLOR_SCALE,
     DARK_GREEN,
     LIGHT_GREEN,
     DARK_GRAY,
@@ -12,3 +10,5 @@ from .formatting import (
     format_fig,
     display_fig,
 )
+
+from .bar import *

policyengine-core-2.5.0/policyengine_core/charts/bar.py

@@ -0,0 +1,133 @@
+import pandas as pd
+from .formatting import *
+import plotly.express as px
+from microdf import MicroSeries
+from typing import Callable
+import numpy as np
+
+
+def bar_chart(
+    data: pd.Series,
+    showlegend: bool = False,
+    remove_zero_index: bool = True,
+    text_format: str = "+.1%",
+    positive_colour: str = BLUE,
+    negative_colour: str = DARK_GRAY,
+    hover_text_function: Callable = None,
+    **kwargs,
+):
+    """Create a PolicyEngine bar chart.
+
+    Args:
+        data (pd.Series): A pandas series.
+        showlegend (bool, optional): Whether to show the legend. Defaults to False.
+        remove_zero_index (bool, optional): Whether to remove the zero index. Defaults to True.
+        text_format (str, optional): The format of the text. Defaults to "+.1%".
+        positive_colour (str, optional): The colour of positive values. Defaults to BLUE.
+        negative_colour (str, optional): The colour of negative values. Defaults to DARK_GRAY.
+        hover_text_labels (list, optional): The hover text labels. Defaults to None.
+
+    Returns:
+        go.Figure: A plotly figure.
+    """
+
+    hover_text_labels = [
+        hover_text_function(index, value)
+        if hover_text_function is not None
+        else None
+        for index, value in data.items()
+    ]
+
+    fig = (
+        px.bar(
+            data,
+            text=data.apply(lambda x: f"{x:{text_format}}"),
+            custom_data=[hover_text_labels] if hover_text_labels else None,
+        )
+        .update_layout(
+            showlegend=showlegend,
+            uniformtext=dict(
+                mode="hide",
+                minsize=12,
+            ),
+            **kwargs,
+        )
+        .update_traces(
+            marker_color=[
+                positive_colour if v > 0 else negative_colour
+                for v in data.values
+            ],
+            hovertemplate="%{customdata[0]}<extra></extra>"
+            if hover_text_labels is not None
+            else None,
+        )
+    )
+    return format_fig(fig)
+
+
+def cross_section_bar_chart(
+    data: MicroSeries,
+    cross_section: MicroSeries,
+    slices: list = [-0.05, -0.01, 0.01, 0.05],
+    add_infinities: bool = True,
+    text_format: str = ".1%",
+    hover_text_function: Callable = None,
+    category_names=None,
+    color_discrete_map: dict = None,
+    **kwargs,
+):
+    df = pd.DataFrame()
+    slices = [-np.inf, *slices, np.inf] if add_infinities else slices
+    for i, lower, upper in zip(range(len(slices)), slices[:-1], slices[1:]):
+        for cross_section_value in cross_section.unique():
+            in_slice = (data >= lower) * (data < upper)
+            value = (
+                data[cross_section == cross_section_value][in_slice].count()
+                / data[cross_section == cross_section_value].count()
+            )
+            category = (
+                category_names[i]
+                if category_names is not None
+                else f"{lower:.0%} to {upper:.0%}"
+            )
+            row = {
+                "Category": category,
+                "Cross section": cross_section_value,
+                "Value": value,
+                "Hover text": hover_text_function(
+                    cross_section_value, category, value
+                )
+                if hover_text_function is not None
+                else None,
+            }
+            df = df.append(row, ignore_index=True)
+
+    fig = (
+        px.bar(
+            df,
+            x="Value",
+            y="Cross section",
+            color="Category",
+            barmode="stack",
+            orientation="h",
+            text=df["Value"].apply(lambda x: f"{x:{text_format}}"),
+            color_discrete_map=color_discrete_map,
+            custom_data=["Hover text"],
+        )
+        .update_layout(
+            xaxis=dict(
+                tickformat="%",
+                title="Fraction of observations",
+            ),
+            yaxis=dict(tickvals=list(range(1, 11))),
+            uniformtext=dict(
+                mode="hide",
+                minsize=12,
+            ),
+            **kwargs,
+        )
+        .update_traces(
+            hovertemplate="%{customdata[0]}<extra></extra>",
+        )
+    )
+    return format_fig(fig)

policyengine-core-2.5.0/policyengine_core/charts/formatting.py

@@ -0,0 +1,80 @@
+import plotly.graph_objects as go
+from IPython.display import HTML
+
+
+WHITE = "#FFF"
+BLUE = "#2C6496"
+GRAY = "#BDBDBD"
+MEDIUM_DARK_GRAY = "#D2D2D2"
+DARK_GRAY = "#616161"
+GREEN = "#29d40f"
+LIGHT_GRAY = "#F2F2F2"
+LIGHT_GREEN = "#C5E1A5"
+DARK_GREEN = "#558B2F"
+BLACK = "#000"
+
+BLUE_COLOR_SCALE = [BLUE, "#265782", "#20496E", "#1A3C5A"]
+
+
+def format_fig(fig: go.Figure) -> go.Figure:
+    """Format a plotly figure to match the PolicyEngine style guide.
+
+    Args:
+        fig (go.Figure): A plotly figure.
+
+    Returns:
+        go.Figure: A plotly figure with the PolicyEngine style guide applied.
+    """
+    fig.update_layout(
+        font=dict(
+            family="Roboto Serif",
+            color="black",
+        )
+    )
+    fig.add_layout_image(
+        dict(
+            source="https://raw.githubusercontent.com/PolicyEngine/policyengine-app/master/src/images/logos/policyengine/blue.png",
+            xref="paper",
+            yref="paper",
+            x=1,
+            y=-0.15,
+            sizex=0.2,
+            sizey=0.2,
+            xanchor="right",
+            yanchor="bottom",
+        )
+    )
+
+    # set template
+    fig.update_layout(
+        template="plotly_white",
+        height=600,
+        width=800,
+    )
+    # don't show modebar
+    fig.update_layout(
+        modebar=dict(
+            bgcolor="rgba(0,0,0,0)",
+            color="rgba(0,0,0,0)",
+        )
+    )
+    return fig
+
+
+def display_fig(fig: go.Figure) -> HTML:
+    return HTML(
+        format_fig(fig).to_html(full_html=False, include_plotlyjs="cdn")
+    )
+
+
+def cardinal(n: int) -> int:
+    """Convert an integer to a cardinal string."""
+    ending_number = n % 10
+    if ending_number == 1:
+        return f"{n}st"
+    elif ending_number == 2:
+        return f"{n}nd"
+    elif ending_number == 3:
+        return f"{n}rd"
+    else:
+        return f"{n}th"

{policyengine-core-2.3.0 → policyengine-core-2.5.0/policyengine_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: policyengine-core
-Version: 2.3.0
+Version: 2.5.0
 Summary: Core microsimulation engine enabling country-specific policy models.
 Home-page: https://github.com/policyengine/policyengine-core
 Author: PolicyEngine

{policyengine-core-2.3.0 → policyengine-core-2.5.0}/policyengine_core.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ policyengine_core.egg-info/entry_points.txt
 policyengine_core.egg-info/requires.txt
 policyengine_core.egg-info/top_level.txt
 policyengine_core/charts/__init__.py
+policyengine_core/charts/bar.py
 policyengine_core/charts/formatting.py
 policyengine_core/commons/__init__.py
 policyengine_core/commons/formulas.py

{policyengine-core-2.3.0 → policyengine-core-2.5.0}/setup.py

@@ -48,7 +48,7 @@ dev_requirements = [
 
 setup(
     name="policyengine-core",
-    version="2.3.0",
+    version="2.5.0",
     author="PolicyEngine",
     author_email="hello@policyengine.org",
     classifiers=[

policyengine-core-2.3.0/policyengine_core/charts/formatting.py

@@ -1,42 +0,0 @@
-import plotly.graph_objects as go
-from IPython.display import HTML
-
-
-WHITE = "#FFF"
-LIGHTER_BLUE = "#ABCEEB"  # Blue 100.
-LIGHT_BLUE = "#49A6E2"  # Blue 500.
-BLUE = "#1976D2"  # Blue 700.
-DARK_BLUE = "#0F4AA1"  # Blue 900.
-GRAY = "#BDBDBD"
-DARK_GRAY = "#616161"
-LIGHT_GRAY = "#F5F5F5"
-LIGHT_GREEN = "#C5E1A5"
-DARK_GREEN = "#558B2F"
-
-
-def format_fig(fig: go.Figure) -> dict:
-    """Formats figure with styling and returns as JSON.
-    :param fig: Plotly figure.
-    :type fig: go.Figure
-    :return: Formatted plotly figure as a JSON dict.
-    :rtype: dict
-    """
-    fig.update_xaxes(
-        title_font=dict(size=16, color="black"), tickfont={"size": 14}
-    )
-    fig.update_yaxes(
-        title_font=dict(size=16, color="black"), tickfont={"size": 14}
-    )
-    return fig.update_layout(
-        hoverlabel_align="right",
-        font_family="Arial, sans-serif",
-        font_color="Black",
-        title_font_size=20,
-        plot_bgcolor="white",
-        paper_bgcolor="white",
-        hoverlabel=dict(font_family="Arial, sans-serif"),
-    )
-
-
-def display_fig(fig: go.Figure) -> HTML:
-    return HTML(fig.to_html(full_html=False, include_plotlyjs="cdn"))