docs(example): Adds Confidence Interval Ellipses (#3747)

* Create deviation_ellipses.py

example showing bivariate deviation ellipses of petal length and width of three iris species

* docs: Initial rewrite of (#514)

Happy with the end result, but not comfortable merging so much complexity I don't understand yet

#3715

* ci(typing): Adds `scipy-stubs` to `altair[doc]`

`scipy` is only used for one example in the user guide, but this will be the second
https://docs.scipy.org/doc/scipy/release/1.15.0-notes.html#other-changes

* fix: Only install `scipy-stubs` on `>=3.10`

* chore(typing): Ignore incorrect `pandas` stubs

* ci(typing): ignore `scipy` on `3.9`

https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-library-stubs-or-py-typed-marker

https://github.com/vega/altair/actions/runs/12612565960/job/35149436953?pr=3747

* docs: Add missing category

* fix: Add missing support for `from __future__ import annotations`

Fixes https://github.com/vega/altair/actions/runs/12612637008/job/35149593128?pr=3747#step:6:25

* test: skip example when `scipy` not installed

Temporary fix for https://github.com/vega/altair/actions/runs/12612997919/job/35150338097?pr=3747

* docs: reduce segments `100` -> `50`

Observed no visible reduction in quality.
Slightly visible at `<=40`

* docs: Clean up `numpy`, `scipy` docs/comments

* refactor: Simplify `numpy` transforms

* docs: add tooltip, increase size

* fix: Remove incorrect range stop

Previously returned `segments+1` rows, but this isn't specified in `ggplot2
https://github.com/tidyverse/ggplot2/blob/efc53cc000e7d86e3db22e1f43089d366fe24f2e/R/stat-ellipse.R#L122

* refactor: Remove special casing `__future__` import

I forgot that the only requirement was that the import is the **first statement**.

Partially reverts (7cd2a77)

* docs: Remove unused `method` code

Also resolves #3747 (comment)

* docs: rename to 'Confidence Interval Ellipses'

* docs: add references to description

* docs: Adds methods syntax version

Includes comment removal suggestion in (#3747 (comment))

* refactor: Rewrite `pd_ellipse`

- Fixed a type ignore (causes by incomplete stubs)
- Renamed variables
- Make replace the implicit `"index"` column with naming it `"order"`

#3747 (comment)

* ci(uv): sync `scipy-stubs`

dc7639d
a296b82

* refactor(typing): Try removing `from __future__ import annotations`

#3747 (comment), #3747 (comment)

* refactor: rename `np_ellipse` -> `confidence_region_2d`

#3747 (comment)

* refactor: rename `pd_ellipse` -> `grouped_confidence_regions`

#3747 (comment)

* docs: change category to `"case studies"`

#3747 (comment)

* styling

---------

Co-authored-by: Serge-Étienne Parent <[email protected]>
Co-authored-by: Mattijn van Hoek <[email protected]>

Author: 3 people

pyproject.toml

@@ -99,6 +99,7 @@ doc = [
     "sphinx_copybutton",
     "sphinx-design",
     "scipy",
+    "scipy-stubs; python_version>=\"3.10\"",
 ]
 
 [tool.altair.vega]
@@ -314,8 +315,10 @@ module = [
     "ipykernel.*",
     "ibis.*",
     "vegafusion.*",
+    "scipy.*"
 ]
 ignore_missing_imports = true
+disable_error_code = ["import-untyped"]
 
 [tool.pyright]
 enableExperimentalFeatures=true

sphinxext/utils.py

@@ -58,7 +58,7 @@ def create_generic_image(
 """
 
 
-def _parse_source_file(filename: str) -> tuple[ast.Module | None, str]:
+def _parse_source_file(filename: str | Path) -> tuple[ast.Module | None, str]:
     """
     Parse source file into AST node.
 
@@ -88,7 +88,7 @@ def _parse_source_file(filename: str) -> tuple[ast.Module | None, str]:
     return node, content
 
 
-def get_docstring_and_rest(filename: str) -> tuple[str, str | None, str, int]:
+def get_docstring_and_rest(filename: str | Path) -> tuple[str, str | None, str, int]:
     """
     Separate ``filename`` content between docstring and the rest.
 
@@ -160,7 +160,7 @@ def get_docstring_and_rest(filename: str) -> tuple[str, str | None, str, int]:
         if (
             node.body
             and isinstance(node.body[0], ast.Expr)
-            and isinstance(node.body[0].value, (ast.Str, ast.Constant))
+            and isinstance(node.body[0].value, ast.Constant)
         ):
             docstring_node = node.body[0]
             docstring = docstring_node.value.s  # pyright: ignore[reportAttributeAccessIssue]

tests/__init__.py

@@ -96,6 +96,10 @@ def windows_has_tzdata() -> bool:
     https://github.com/vega/vegafusion
 """
 
+skip_requires_scipy: pytest.MarkDecorator = pytest.mark.skipif(
+    find_spec("scipy") is None, reason="`scipy` not installed."
+)
+
 
 @overload
 def skip_requires_pyarrow(
@@ -236,6 +240,7 @@ def _distributed_examples(
                 "wind_vector_map": slow,
                 r"\.point_map\.py": slow,
                 "line_chart_with_color_datum": slow,
+                "deviation_ellipses": skip_requires_scipy,
             },
         )
     ),

tests/examples_arguments_syntax/deviation_ellipses.py

@@ -0,0 +1,88 @@
+"""
+Confidence Interval Ellipses
+----------------------------
+This example shows bivariate deviation ellipses of petal length and width of three iris species.
+
+Inspired by `ggplot2.stat_ellipse`_ and directly based on `Deviation ellipses example`_ by `@essicolo`_
+
+.. _ggplot2.stat_ellipse:
+    https://ggplot2.tidyverse.org/reference/stat_ellipse.html#ref-examples
+.. _Deviation ellipses example:
+    https://github.com/vega/altair/pull/514
+.. _@essicolo:
+    https://github.com/essicolo
+"""
+
+# category: case studies
+import numpy as np
+import pandas as pd
+from scipy.stats import f as F
+
+import altair as alt
+from vega_datasets import data
+
+
+def confidence_region_2d(arr, conf_level=0.95, segments=50):
+    """
+    Calculate confidence interval ellipse.
+
+    Parameters
+    ----------
+    arr
+        numpy array with 2 columns
+    conf_level
+        lower tail probability
+    segments
+        number of points describing the ellipse.
+    """
+    n_elements = len(arr)
+    # Degrees of freedom of the chi-squared distribution in the **numerator**
+    dfn = 2
+    # Degrees of freedom of the chi-squared distribution in the **denominator**
+    dfd = n_elements - 1
+    # Percent point function at `conf_level` of an F continuous random variable
+    quantile = F.ppf(conf_level, dfn=dfn, dfd=dfd)
+    radius = np.sqrt(2 * quantile)
+    angles = np.arange(0, segments) * 2 * np.pi / segments
+    circle = np.column_stack((np.cos(angles), np.sin(angles)))
+    center = np.mean(arr, axis=0)
+    cov_mat = np.cov(arr, rowvar=False)
+    return center + radius * (circle @ np.linalg.cholesky(cov_mat).T)
+
+
+def grouped_confidence_regions(df, col_x, col_y, col_group):
+    cols = [col_x, col_y]
+    ellipses = []
+    ser: pd.Series[float] = df[col_group]
+    for group in ser.drop_duplicates():
+        arr = df.loc[ser == group, cols].to_numpy()
+        ellipse = pd.DataFrame(confidence_region_2d(arr), columns=cols)
+        ellipse[col_group] = group
+        ellipses.append(ellipse)
+    return pd.concat(ellipses).reset_index(names="order")
+
+
+col_x = "petalLength"
+col_y = "petalWidth"
+col_group = "species"
+
+x = alt.X(col_x, scale=alt.Scale(zero=False))
+y = alt.Y(col_y, scale=alt.Scale(zero=False))
+color = alt.Color(col_group)
+
+source = data.iris()
+ellipse = grouped_confidence_regions(source, col_x=col_x, col_y=col_y, col_group=col_group)
+points = alt.Chart(source).mark_circle(size=50, tooltip=True).encode(
+    x=x,
+    y=y,
+    color=color
+)
+lines = alt.Chart(ellipse).mark_line(filled=True, fillOpacity=0.2).encode(
+    x=x,
+    y=y,
+    color=color,
+    order="order"
+)
+
+chart = (lines + points).properties(height=500, width=500)
+chart

tests/examples_methods_syntax/deviation_ellipses.py

@@ -0,0 +1,88 @@
+"""
+Confidence Interval Ellipses
+----------------------------
+This example shows bivariate deviation ellipses of petal length and width of three iris species.
+
+Inspired by `ggplot2.stat_ellipse`_ and directly based on `Deviation ellipses example`_ by `@essicolo`_
+
+.. _ggplot2.stat_ellipse:
+    https://ggplot2.tidyverse.org/reference/stat_ellipse.html#ref-examples
+.. _Deviation ellipses example:
+    https://github.com/vega/altair/pull/514
+.. _@essicolo:
+    https://github.com/essicolo
+"""
+
+# category: case studies
+import numpy as np
+import pandas as pd
+from scipy.stats import f as F
+
+import altair as alt
+from vega_datasets import data
+
+
+def confidence_region_2d(arr, conf_level=0.95, segments=50):
+    """
+    Calculate confidence interval ellipse.
+
+    Parameters
+    ----------
+    arr
+        numpy array with 2 columns
+    conf_level
+        lower tail probability
+    segments
+        number of points describing the ellipse.
+    """
+    n_elements = len(arr)
+    # Degrees of freedom of the chi-squared distribution in the **numerator**
+    dfn = 2
+    # Degrees of freedom of the chi-squared distribution in the **denominator**
+    dfd = n_elements - 1
+    # Percent point function at `conf_level` of an F continuous random variable
+    quantile = F.ppf(conf_level, dfn=dfn, dfd=dfd)
+    radius = np.sqrt(2 * quantile)
+    angles = np.arange(0, segments) * 2 * np.pi / segments
+    circle = np.column_stack((np.cos(angles), np.sin(angles)))
+    center = np.mean(arr, axis=0)
+    cov_mat = np.cov(arr, rowvar=False)
+    return center + radius * (circle @ np.linalg.cholesky(cov_mat).T)
+
+
+def grouped_confidence_regions(df, col_x, col_y, col_group):
+    cols = [col_x, col_y]
+    ellipses = []
+    ser: pd.Series[float] = df[col_group]
+    for group in ser.drop_duplicates():
+        arr = df.loc[ser == group, cols].to_numpy()
+        ellipse = pd.DataFrame(confidence_region_2d(arr), columns=cols)
+        ellipse[col_group] = group
+        ellipses.append(ellipse)
+    return pd.concat(ellipses).reset_index(names="order")
+
+
+col_x = "petalLength"
+col_y = "petalWidth"
+col_group = "species"
+
+x = alt.X(col_x).scale(zero=False)
+y = alt.Y(col_y).scale(zero=False)
+color = alt.Color(col_group)
+
+source = data.iris()
+ellipse = grouped_confidence_regions(source, col_x=col_x, col_y=col_y, col_group=col_group)
+points = alt.Chart(source).mark_circle(size=50, tooltip=True).encode(
+    x=x,
+    y=y,
+    color=color
+)
+lines = alt.Chart(ellipse).mark_line(filled=True, fillOpacity=0.2).encode(
+    x=x,
+    y=y,
+    color=color,
+    order="order"
+)
+
+chart = (lines + points).properties(height=500, width=500)
+chart