drippy.comparative
==================

.. py:module:: drippy.comparative

.. autoapi-nested-parse::

   Plotting functions for comparative and multivariate models.



Attributes
----------

.. autoapisummary::

   drippy.comparative._MARKERS


Functions
---------

.. autoapisummary::

   drippy.comparative.block_plot
   drippy.comparative.youden_plot
   drippy.comparative.star_plot


Module Contents
---------------

.. py:data:: _MARKERS
   :value: ['o', 's', '^', 'D', 'v', 'P', '*', 'X']


.. py:function:: block_plot(data: drippy.data.EDAData, fig: matplotlib.figure.Figure | None = None, ax: matplotlib.axes.Axes | None = None) -> tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Creates a block plot of y vs treatment, grouped by block.

   Shows treatment effects within each block as connected line segments,
   one series per block level.

   :param data: EDAData container. Requires factors with keys
                ``"treatment"`` and ``"block"``.
   :param fig: Matplotlib figure. If None, creates new figure.
   :param ax: Matplotlib axes. If None, creates new axes.

   :returns: The figure and axes containing the plot.

   :raises ValueError: If factors is None or missing required keys.


.. py:function:: youden_plot(data: drippy.data.EDAData, fig: matplotlib.figure.Figure | None = None, ax: matplotlib.axes.Axes | None = None, doe: bool = False) -> tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Creates a Youden plot comparing two labs or measurement methods.

   Plots Lab 1 (y) vs Lab 2 (x) with an equality line and median
   reference lines to reveal bias and lab effects.

   :param data: EDAData container. Requires x (Lab 2 measurements)
                and y (Lab 1 measurements).
   :param fig: Matplotlib figure. If None, creates new figure.
   :param ax: Matplotlib axes. If None, creates new axes.
   :param doe: If True, overlays DOE design point markers.

   :returns: The figure and axes containing the plot.

   :raises ValueError: If x is None.


.. py:function:: star_plot(data: drippy.data.EDAData, fig: matplotlib.figure.Figure | None = None, ax: matplotlib.axes.Axes | None = None) -> tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Creates a star (radar) plot of multivariate data.

   Each observation is drawn as a polygon on a polar axis, with one
   spoke per variable. Values are normalized 0-1 per variable.

   :param data: EDAData container. Requires factors for additional
                variables beyond y.
   :param fig: Matplotlib figure. If None, creates new polar figure.
   :param ax: Matplotlib axes (polar). If None, creates new polar axes.

   :returns: The figure and axes containing the plot.

   :raises ValueError: If factors is None.