leaf_engine.adapt.network.utilities
===================================

.. py:module:: leaf_engine.adapt.network.utilities


Functions
---------

.. autoapisummary::

   leaf_engine.adapt.network.utilities.e_lane_ids
   leaf_engine.adapt.network.utilities.filter_block_list
   leaf_engine.adapt.network.utilities.i_lane_ids
   leaf_engine.adapt.network.utilities.l_lane_ids
   leaf_engine.adapt.network.utilities.prefix_lane_ids
   leaf_engine.adapt.network.utilities.rename_cols
   leaf_engine.adapt.network.utilities.union_dicts


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

.. py:function:: e_lane_ids(df: pandas.DataFrame) -> pandas.DataFrame

   Given a DataFrame with 'lane_id' column, returns DataFrame with 'lane_id'
   numeric values prefixed with 'E' (external lanes)


.. py:function:: filter_block_list(df: pandas.DataFrame) -> pandas.DataFrame

   Filter out lanes that are in the block list.

   Currently list is outdated and maintained in gsheet.


.. py:function:: i_lane_ids(df: pandas.DataFrame) -> pandas.DataFrame

   Given a DataFrame with 'lane_id' column, returns DataFrame with 'lane_id'
   numeric values prefixed with 'I' (internal lanes)


.. py:function:: l_lane_ids(df: pandas.DataFrame) -> pandas.DataFrame

   Given a DataFrame with 'lane_id' column, returns DataFrame with 'lane_id'
   numeric values prefixed with 'L' (leaf lanes)


.. py:function:: prefix_lane_ids(df: pandas.DataFrame, company_id: int, leaf_company_ids: list) -> pandas.Series

.. py:function:: rename_cols(df, patterns)

   Given a dict of the form {'from':'to'}, rename columns of the dataframe,
   replacing any instances of 'from' with 'to'.


.. py:function:: union_dicts(dicts: list)

   Merges two dicts together.