data_plotting
=============

.. py:module:: data_plotting


Functions
---------

.. autoapisummary::

   data_plotting.plot_predictors
   data_plotting.plot_predicted_vs_actual


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

.. py:function:: plot_predictors(data_frame, y)

   Plot a series of factors in a dataframe against an output y.

   Parameters
   ----------
       data_frame : dataframe
           Dataframe of sampled factors
       y : list/np.array
           Vector of outputs following sampling using the data_frame


.. py:function:: plot_predicted_vs_actual(y, y_hat)

   Plot predicted cost y_hat against actual cost y.

   Parameters
   ----------
       y : list/np.array
           Actual y
       y_hat : list/np.array
           Predicted y