cdm_reader_mapper.split_by_boolean_true

cdm_reader_mapper.split_by_boolean_true#

cdm_reader_mapper.split_by_boolean_true(data, mask, reset_index=False, inverse=False, return_rejected=False)[source]#

Split rows where all mask columns are True.

Parameters:

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

  • mask (pandas.DataFrame) – Boolean mask with the same length as data.

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

  • inverse (bool, optional) – If True, invert the selection.

  • 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.