fips.indexes.overlaps#

fips.indexes.overlaps(target_idx, available_idx)[source]#

Check if target index overlaps with available index.

Returns True if fully covered, ‘partial’ if partially covered, and False if no overlap.

Parameters:
  • target_idx (pd.Index) – The index we want to check for coverage.

  • available_idx (pd.Index) – The index that represents available data.

Returns:

True if target_idx is fully covered by available_idx, ‘partial’ if partially covered, and False if no overlap.

Return type:

bool or ‘partial’