pegasus.estimate_background_probs

pegasus.estimate_background_probs(hashing_data, random_state=0)

For cell-hashing data, estimate antibody background probability using KMeans algorithm.

Parameters

• hashing_data (UnimodalData) – Annotated data matrix for antibody.

• random_state (int, optional, default: 0) – Random seed set for reproducing results.

Return type

None

Returns

• None

• Update ``hashing_data`` (Filtered cell barcodes with 0 counts)

• Update hashing_data.uns –

  • hashing_data.uns["background_probs"]: estimated antibody background probability.

Example

>>> estimate_background_probs(hashing_data)