linreg_ally.eda
===============

.. py:module:: linreg_ally.eda


Functions
---------

.. autoapisummary::

   linreg_ally.eda.eda_summary


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

.. py:function:: eda_summary(train_df: pandas.DataFrame, color: str = None) -> altair.ConcatChart

   Does preliminary exploratory data analysis (EDA) on dataset
   to return plots to the user

   :param train_df: Training dataset
   :type train_df: pd.DataFrame
   :param color: Column name in `train_df` to be used for coloring the data
   :type color: str, default None

   :returns: A chart that shows the distributions of various input features
   :rtype: alt.ConcatChart

   :raises KeyError: When `color` is not in the `train_df` columns
   :raises TypeError: When either `train_df` or `color` is not the expected type

   .. rubric:: Examples

   >>> from linreg_ally.eda import eda_summary
   >>> summary_chart = eda_summary(train_df, color='y')
   >>> summary_chart.show()