mosaicmpi.network.Network.get_community_category_overrepresentation

mosaicmpi.network.Network.get_community_category_overrepresentation#

Network.get_community_category_overrepresentation(layer: str, subset_datasets: str | Iterable | None = None, truncate_negative: bool = True, subset_categories: Collection[str] = None) → DataFrame#

_summary_

Parameters:

  • layer (str) – name of categorical data layer

  • subset_datasets (str or Iterable[str], optional) – dataset name or iterable of dataset names to subset the results, defaults to None

  • truncate_negative (bool, optional) – Truncate negative residuals to 0, defaults to True

  • subset_categories (Collection[str]) – Provide a subset of categories for calculating overrepresentation

Returns:

category × program matrix of overrepresentation values

Return type:

pd.DataFrame

Contents