leaspy.io.data.joint_dataframe_data_reader
==========================================

.. py:module:: leaspy.io.data.joint_dataframe_data_reader


Classes
-------

.. autoapisummary::

   leaspy.io.data.joint_dataframe_data_reader.JointDataframeDataReader


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

.. py:class:: JointDataframeDataReader(*, event_time_name = 'EVENT_TIME', event_bool_name = 'EVENT_BOOL', nb_events = None)

   Bases: :py:obj:`leaspy.io.data.abstract_dataframe_data_reader.AbstractDataframeDataReader`


   
   Methods to convert :class:`pandas.DataFrame` to `Leaspy`-compliant data containers for event data and longitudinal data.


   :Parameters:

       **event_time_name: str**
           Name of the columns in dataframe that contains the time of event

       **event_bool_name: str**
           Name of the columns in dataframe that contains if the event is censored of not







   :Raises:

       :exc:`.LeaspyDataInputError`
           ..







   ..
       !! processed by numpydoc !!

   .. py:attribute:: tol_diff
      :value: 0.001



   .. py:attribute:: visit_reader


   .. py:attribute:: event_reader


   .. py:property:: event_time_name
      :type: str


      
      Name of the event time column in dataset
















      ..
          !! processed by numpydoc !!


   .. py:property:: event_bool_name
      :type: str


      
      Name of the event bool column in dataset
















      ..
          !! processed by numpydoc !!


   .. py:property:: dimension
      :type: Optional[int]


      
      Number of longitudinal outcomes in dataset.
















      ..
          !! processed by numpydoc !!


   .. py:property:: long_outcome_names
      :type: list[leaspy.utils.typing.FeatureType]


      
      Name of the longitudinal outcomes in dataset
















      ..
          !! processed by numpydoc !!


   .. py:property:: n_visits
      :type: int


      
      Number of visit in the dataset
















      ..
          !! processed by numpydoc !!