openbb-charting 2.2.3__tar.gz → 2.2.4__tar.gz

{openbb_charting-2.2.3 → openbb_charting-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openbb-charting
-Version: 2.2.3
+Version: 2.2.4
 Summary: Charting extension for OpenBB
 License: AGPL-3.0-only
 Author: OpenBB Team
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: pywry
 Requires-Dist: nbformat (>=5.9.2,<6.0.0)
 Requires-Dist: numpy (>=1,<2)
-Requires-Dist: openbb-core (>=1.3.3,<2.0.0)
+Requires-Dist: openbb-core (>=1.3.5,<2.0.0)
 Requires-Dist: pandas-ta (>=0.3.14b,<0.4.0)
 Requires-Dist: plotly (>=5.17.0,<6.0.0)
 Requires-Dist: pywry (>=0.6.1,<0.7.0) ; extra == "pywry"

{openbb_charting-2.2.3 → openbb_charting-2.2.4}/openbb_charting/charting.py

@@ -1,6 +1,6 @@
 """Charting Class implementation."""
 
-# pylint: disable=too-many-arguments,unused-argument
+# pylint: disable=too-many-arguments,unused-argument,too-many-positional-arguments
 
 from typing import (
     TYPE_CHECKING,
@@ -57,6 +57,8 @@ class Charting:
         Create a line chart from external data.
     create_bar_chart
         Create a bar chart, on a single x-axis with one or more values for the y-axis, from external data.
+    create_correlation_matrix
+        Create a correlation matrix from external data.
     toggle_chart_style
         Toggle the chart style, of an existing chart, between light and dark mode.
     """
@@ -367,6 +369,54 @@ class Charting:
 
         return fig
 
+    def create_correlation_matrix(
+        self,
+        data: Union[
+            list[Data],
+            "DataFrame",
+        ],
+        method: Literal["pearson", "kendall", "spearman"] = "pearson",
+        colorscale: str = "RdBu",
+        title: str = "Asset Correlation Matrix",
+        layout_kwargs: Optional[Dict[str, Any]] = None,
+    ):
+        """Create a correlation matrix from external data.
+
+        Parameters
+        ----------
+        data : Union[list[Data], DataFrame]
+            Input dataset.
+        method : Literal["pearson", "kendall", "spearman"]
+            Method to use for correlation calculation. Default is "pearson".
+                pearson : standard correlation coefficient
+                kendall : Kendall Tau correlation coefficient
+                spearman : Spearman rank correlation
+        colorscale : str
+            Plotly colorscale to use for the heatmap. Default is "RdBu".
+        title : str
+            Title of the chart. Default is "Asset Correlation Matrix".
+        layout_kwargs : Dict[str, Any]
+            Additional keyword arguments to apply with figure.update_layout(), by default None.
+
+        Returns
+        -------
+        OpenBBFigure
+            The OpenBBFigure object.
+        """
+        # pylint: disable=import-outside-toplevel
+        from openbb_charting.charts.correlation_matrix import correlation_matrix
+
+        kwargs = {
+            "data": data,
+            "method": method,
+            "colorscale": colorscale,
+            "title": title,
+            "layout_kwargs": layout_kwargs,
+        }
+        fig, _ = correlation_matrix(**kwargs)
+        fig = self._set_chart_style(fig)
+        return fig
+
     # pylint: disable=inconsistent-return-statements
     def show(self, render: bool = True, **kwargs):
         """Display chart and save it to the OBBject."""

openbb_charting-2.2.4/openbb_charting/charts/correlation_matrix.py

@@ -0,0 +1,119 @@
+"""Correlation Matrix Chart."""
+
+from typing import TYPE_CHECKING, Any, Union
+
+if TYPE_CHECKING:
+    from plotly.graph_objs import Figure  # noqa
+    from openbb_charting.core.openbb_figure import OpenBBFigure  # noqa
+
+
+def correlation_matrix(  # noqa: PLR0912
+    **kwargs,
+) -> tuple[Union["OpenBBFigure", "Figure"], dict[str, Any]]:
+    """Correlation Matrix Chart."""
+    # pylint: disable=import-outside-toplevel
+    from numpy import ones_like, triu  # noqa
+    from openbb_core.app.utils import basemodel_to_df  # noqa
+    from openbb_charting.core.openbb_figure import OpenBBFigure
+    from openbb_charting.core.chart_style import ChartStyle
+    from plotly.graph_objs import Figure, Heatmap, Layout
+    from pandas import DataFrame
+
+    if "data" in kwargs and isinstance(kwargs["data"], DataFrame):
+        corr = kwargs["data"]
+    elif "data" in kwargs and isinstance(kwargs["data"], list):
+        corr = basemodel_to_df(kwargs["data"], index=kwargs.get("index", "date"))  # type: ignore
+    else:
+        corr = basemodel_to_df(
+            kwargs["obbject_item"], index=kwargs.get("index", "date")  # type: ignore
+        )
+    if (
+        "symbol" in corr.columns
+        and len(corr.symbol.unique()) > 1
+        and "close" in corr.columns
+    ):
+        corr = corr.pivot(
+            columns="symbol",
+            values="close",
+        )
+
+    method = kwargs.get("method") or "pearson"
+    corr = corr.corr(method=method, numeric_only=True)
+
+    X = corr.columns.to_list()
+    x_replace = X[-1]
+    Y = X.copy()
+    y_replace = Y[0]
+    X = [x if x != x_replace else "" for x in X]
+    Y = [y if y != y_replace else "" for y in Y]
+    mask = triu(ones_like(corr, dtype=bool))
+    df = corr.mask(mask)
+    title = kwargs.get("title") or "Asset Correlation Matrix"
+    text_color = "white" if ChartStyle().plt_style == "dark" else "black"
+    colorscale = kwargs.get("colorscale") or "RdBu"
+
+    heatmap = Heatmap(
+        z=df,
+        x=X,
+        y=Y,
+        xgap=1,
+        ygap=1,
+        colorscale=colorscale,
+        colorbar=dict(
+            orientation="v",
+            x=0.8,
+            y=0.5,
+            xanchor="left",
+            yanchor="middle",
+            xref="container",
+            yref="paper",
+            len=0.66,
+            bgcolor="rgba(0,0,0,0)" if text_color == "white" else "rgba(255,255,255,0)",
+        ),
+        text=df.fillna(""),
+        texttemplate="%{text:.4f}",
+        hoverongaps=False,
+        hovertemplate="%{x} - %{y} : %{z:.4f}<extra></extra>",
+    )
+    layout = Layout(
+        title=title,
+        title_x=0.5,
+        xaxis=dict(
+            showgrid=False,
+            showline=False,
+            ticklen=0,
+            domain=[0.03, 1],
+            tickangle=90,
+            automargin=False,
+        ),
+        yaxis=dict(
+            showgrid=False,
+            side="left",
+            autorange="reversed",
+            showline=False,
+            ticklen=0,
+            automargin="height+width+left",
+            tickmode="auto",
+        ),
+        margin=dict(l=10, r=0, t=0, b=10),
+        dragmode="pan",
+    )
+    fig = Figure(data=[heatmap], layout=layout)
+    figure = OpenBBFigure(fig=fig)
+    figure.update_layout(
+        font=dict(color=text_color),
+        paper_bgcolor=(
+            "rgba(0,0,0,0)" if text_color == "white" else "rgba(255,255,255,0)"
+        ),
+        plot_bgcolor=(
+            "rgba(0,0,0,0)" if text_color == "white" else "rgba(255,255,255,0)"
+        ),
+    )
+    layout_kwargs = kwargs.get("layout_kwargs", {})
+
+    if layout_kwargs:
+        figure.update_layout(**layout_kwargs)
+
+    content = figure.show(external=True).to_plotly_json()  # type: ignore
+
+    return figure, content

{openbb_charting-2.2.3 → openbb_charting-2.2.4}/openbb_charting/charts/generic_charts.py

@@ -1,6 +1,6 @@
 """Generic Charts Module."""
 
-# pylint: disable=too-many-arguments,unused-argument,too-many-locals, too-many-branches, too-many-lines, too-many-statements, use-dict-literal, broad-exception-caught, too-many-nested-blocks
+# pylint: disable=too-many-arguments,unused-argument,too-many-locals, too-many-branches, too-many-lines, too-many-statements, use-dict-literal, broad-exception-caught, too-many-nested-blocks, too-many-positional-arguments
 
 from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Union
 

{openbb_charting-2.2.3 → openbb_charting-2.2.4}/openbb_charting/core/openbb_figure.py

@@ -1,6 +1,6 @@
 """OpenBB Figure Class."""
 
-# pylint: disable=C0302,R0902,W3301
+# pylint: disable=C0302,R0902,W3301,R0917
 import json
 import textwrap
 from datetime import datetime, timedelta

{openbb_charting-2.2.3 → openbb_charting-2.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-charting"
-version = "2.2.3"
+version = "2.2.4"
 description = "Charting extension for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
@@ -15,7 +15,7 @@ statsmodels = "^0.14.0"
 pywry = { version = "^0.6.1", optional = true }
 nbformat = "^5.9.2"
 pandas-ta = "^0.3.14b"
-openbb-core = "^1.3.3"
+openbb-core = "^1.3.5"
 numpy = "^1"
 
 [tool.poetry.extras]