cdm_reader_mapper.split_by_index

Contents

cdm_reader_mapper.split_by_index#

cdm_reader_mapper.split_by_index(data, index, reset_index=False, inverse=False, return_rejected=False)[source]#

Split a DataFrame by selecting specific index labels.

Parameters:

  • data (pandas.DataFrame) – DataFrame to be split.

  • index (label or sequence of labels) – Index values to select.

  • reset_index (bool, optional) – If True, reset index in returned DataFrames.

  • inverse (bool, optional) – If True, select rows not in index.

  • return_rejected (bool, optional) – If True, return rejected rows as the second output. If False, the rejected output is empty but dtype-preserving.

Return type:

tuple[DataFrame | ParquetStreamReader, DataFrame | ParquetStreamReader, Index | MultiIndex, Index | MultiIndex]

Returns:

(pandas.DataFrame or ParquetStreamReader, pandas.DataFrame or ParquetStreamReader, pd.Index or pd.MultiIndex, pd.Index or pd.MultiIndex) – Selected rows (all mask columns True), rejected rows, original indexes of selection and original indexes of rejection.

Contents