napari_prism.pp.filter_by_obs_count

napari_prism.pp.filter_by_obs_count#

napari_prism.pp.filter_by_obs_count(adata, obs_col, min_value=None, max_value=None, copy=True)#

Filters cells which belong to a category in AnnData.obs with a cell count less than a min_value and/or more than a max_value. If layer is None, does this on .X.

Parameters:

  • adata (AnnData) – Anndata object.

  • obs_col (str) – AnnData.obs column to filter by.

  • min_value (Optional[float] (default: None)) – Minimum value to filter by.

  • max_value (Optional[float] (default: None)) – Maximum value to filter by.

  • copy (bool (default: True)) – Return a copy instead of writing inplace.

Return type:

AnnData | None

Returns:

Filtered AnnData object. If copy is False, modifies the AnnData object in place and returns None.

Contents