mosaicmpi.network.Network.transfer_labels

mosaicmpi.network.Network.transfer_labels#

Network.transfer_labels(source: str | Collection[str] | None = None, dest: str | Collection[str] | None = None, categories: str | Collection[str] | None = None, subset_categories: Collection[str] = None, simplify: bool = True) → DataFrame#

Transfer sample categories between datasets using usage of representative programs as a proxy.

Parameters:

  • source (Union[str, Collection[str]], optional) – Source dataset(s) for label transfer, defaults to None

  • dest (Union[str, Collection[str]], optional) – Target dataset(s) for label transfer, defaults to None

  • categories (Union[str, Collection[str]], optional) – name of categorical metadata field(s) from source dataset, defaults to None

  • subset_categories (Collection[str], optional) – a subset of categories for calculating overrepresentation, defaults to None

  • simplify (bool, optional) – Simplify multi-index results when only one source, dest, or layer are specified, defaults to True

Raises:

ValueError – if source or dest is not a correct type

Returns:

transfer score

Return type:

pd.DataFrame

Contents