stepsel.tools
=============

.. py:module:: stepsel.tools

.. autoapi-nested-parse::

   The :mod:`stepsel.tools` module includes handy functions for different tasks.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/stepsel/tools/group_over_columns/index


Functions
---------

.. autoapisummary::

   stepsel.tools.group_over_columns


Package Contents
----------------

.. py:function:: group_over_columns(dt: pandas.DataFrame, columns: numpy.typing.ArrayLike, agg_dict: dict) -> pandas.DataFrame

   Group over columns and aggregate by agg_dict

   :param dt: Dataframe to group over
   :type dt: pd.DataFrame
   :param columns: Columns to group over. It can be a list of columns or a list of lists of columns.
   :type columns: ArrayLike
   :param agg_dict: Dictionary of columns and aggregation functions
   :type agg_dict: dict

   :returns: **comparison** -- Dataframe with grouped and aggregated data
   :rtype: pd.DataFrame

   .. rubric:: Examples

   >>> group_over_columns(dt, ["catvar1", "catvar2"], {"smlr": "sum", "preds": "mean", target: "mean"})
   >>> group_over_columns(dt, [["catvar1", "catvar2"]], {"smlr": "sum", "preds": "mean", target: "mean"})
   >>> group_over_columns(dt, [["catvar1", "catvar2"], "catvar3"], {"smlr": "sum", "preds": "mean", target: "mean"})