dandelion.tools.clone_rarefaction

dandelion.tools.clone_rarefaction(self, groupby, clone_key=None, diversity_key=None)[source]

Returns rarefaction predictions for cell numbers vs clone size.

Parameters
  • self (Dandelion, AnnData) – Dandelion or AnnData object.

  • groupby (str) – Column name to split the calculation of clone numbers for a given number of cells for e.g. sample, patient etc.

  • clone_key (str, optional) – Column name specifying the clone_id column in metadata/obs.

  • diversity_key (str, optional) – key for ‘diversity’ results in AnnData’s .uns.

Returns

Return type

Dictionary containing rarefaction results or updated .uns slot if AnnData object is used.