seismometer.data.performance.assert_valid_performance_metrics_df

seismometer.data.performance.assert_valid_performance_metrics_df(df, needs_columns=None)

Determines whether a passed dataframe has either all or a subset of columns that likely indicate it was generated by calculate_bin_stats.

Parameters:
  • df (pd.DataFrame) – DataFrame under investigation.

  • needs_columns (list) – List of columns that need to be present in order to be determined valid. Default is all columns normally generated by calculate_bin_stats.

Returns:

Whether it is likely a valid performance metrics df.

Return type:

bool