proteometer.quality_control_plots
=================================

.. py:module:: proteometer.quality_control_plots


Functions
---------

.. autoapisummary::

   proteometer.quality_control_plots.volcano_plot
   proteometer.quality_control_plots.biplot
   proteometer.quality_control_plots.correlation_plot


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

.. py:function:: volcano_plot(df: pandas.DataFrame, comparison: str, ax: matplotlib.axes.Axes | None = None, sig_type: str = 'adj-p', sig_thresh: float = 0.1, max_color_value: float | None = None) -> matplotlib.axes.Axes

   Plots a volcano plot of the data.

   :param df: DataFrame containing the data.
   :type df: pd.DataFrame
   :param comparison: The comparison to plot.
   :type comparison: str
   :param ax: Matplotlib Axes object to draw the volcano plot on.
              If `None`, a new Axes object is created. Defaults to `None`.
   :type ax: Axes | None, optional
   :param sig_type: The type of significance to use. Defaults to "adj-p".
   :type sig_type: str, optional
   :param sig_thresh: The significance threshold to use. Defaults to 0.1.
   :type sig_thresh: float, optional
   :param max_color_value: Value at which the color scale should stop (symmetrical about zero).
                           If None, the maximum absolute value in the data is used.
   :type max_color_value: float | None, optional

   :returns: The matplotlib Axes object with the plotted volcano plot.
   :rtype: Axes


.. py:function:: biplot(df: pandas.DataFrame, int_cols: list[str], group_cols: list[list[str]], ax: matplotlib.axes.Axes | None = None) -> matplotlib.axes.Axes

   Plots a biplot of the data.

   :param df: DataFrame containing the data.
   :type df: pd.DataFrame
   :param int_cols: List of columns to plot.
   :type int_cols: list[str]
   :param group_cols: List of lists of columns to group by.
   :type group_cols: list[list[str]]
   :param ax: Matplotlib Axes object to draw the biplot on.
              If `None`, a new Axes object is created. Defaults to `None`.
   :type ax: Axes | None, optional

   :returns: The matplotlib Axes object with the plotted biplot.
   :rtype: Axes


.. py:function:: correlation_plot(df: pandas.DataFrame, int_cols: list[str], ax: matplotlib.axes.Axes | None = None) -> matplotlib.axes.Axes

   Plots a correlation heatmap of the data.

   :param df: DataFrame containing the data.
   :type df: pd.DataFrame
   :param int_cols: List of columns to plot.
   :type int_cols: list[str]
   :param ax: Matplotlib Axes object to draw the correlation heatmap on.
              If `None`, a new Axes object is created. Defaults to `None`.
   :type ax: Axes | None, optional

   :returns: The matplotlib Axes object with the plotted correlation heatmap.
   :rtype: Axes