dandelion.polars.tools.productive_ratio

dandelion.polars.tools.productive_ratio(adata, vdj, group_by, groups=None, locus='TRB')[source]

Compute the cell-level productive/non-productive contig ratio.

Only the contig with the highest umi count in a cell will be used for this tabulation.

Parameters:

  • adata (AnnData) – AnnData object holding the cell level metadata (.obs).

  • vdj (DandelionPolars) – DandelionPolars object holding the repertoire data (.data).

  • group_by (str) – Name of column in AnnData.obs to return the row tabulations.

  • groups (list[str] | None, optional) – Optional list of categories to return.

  • locus (Literal[“TRB”, “TRA”, “TRD”, “TRG”, “IGH”, “IGK”, “IGL”], optional) – One of the accepted locuses to perform the tabulation

Returns:

Modifies adata in place, storing the result in adata.uns['productive_ratio'].

Return type:

None