leaspy.io.data.joint_dataframe_data_reader

Classes

JointDataframeDataReader

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

Module Contents

class JointDataframeDataReader(*, event_time_name='EVENT_TIME', event_bool_name='EVENT_BOOL', nb_events=None)[source]

Bases: leaspy.io.data.abstract_dataframe_data_reader.AbstractDataframeDataReader

Methods to convert 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:
LeaspyDataInputError
Parameters:

  • event_time_name (str)

  • event_bool_name (str)

  • nb_events (Optional[int])

tol_diff = 0.001
visit_reader
event_reader
property event_time_name: str

Name of the event time column in dataset

Return type:

str

property event_bool_name: str

Name of the event bool column in dataset

Return type:

str

property dimension: int | None

Number of longitudinal outcomes in dataset.

Return type:

Optional[int]

property long_outcome_names: list[FeatureType]

Name of the longitudinal outcomes in dataset

Return type:

list[FeatureType]

property n_visits: int

Number of visit in the dataset

Return type:

int