leaspy.io.data.abstract_dataframe_data_reader
=============================================

.. py:module:: leaspy.io.data.abstract_dataframe_data_reader


Classes
-------

.. autoapisummary::

   leaspy.io.data.abstract_dataframe_data_reader.AbstractDataframeDataReader


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

.. py:class:: AbstractDataframeDataReader

   
   Methods to convert :class:`pandas.DataFrame` to `Leaspy`-compliant data containers.









   :Raises:

       :exc:`.LeaspyDataInputError`
           ..







   ..
       !! processed by numpydoc !!

   .. py:attribute:: time_rounding_digits
      :value: 6



   .. py:attribute:: individuals
      :type:  dict[leaspy.utils.typing.IDType, leaspy.io.data.individual_data.IndividualData]


   .. py:attribute:: iter_to_idx
      :type:  dict[int, leaspy.utils.typing.IDType]


   .. py:attribute:: n_individuals
      :type:  int
      :value: 0



   .. py:method:: read(df, *, drop_full_nan = True, sort_index = False, warn_empty_column = True)

      
      The method that effectively reads the input dataframe (automatically called in __init__).


      :Parameters:

          **df** : :class:`pandas.DataFrame`
              The dataframe to read.

          **drop_full_nan** : bool
              Should we drop rows full of nans? (except index)

          **sort_index** : bool
              Should we lexsort index?
              (Keep False as default so not to break many of the downstream tests that check order...)

          **warn_empty_column** : bool
              Should we warn when there are empty columns?














      ..
          !! processed by numpydoc !!