BAITS.VDJ.tl.Clonal_family_diversification

BAITS.VDJ.tl.Clonal_family_diversification#

BAITS.VDJ.tl.Clonal_family_diversification(df, sample_col='sample', cluster_col='BCR_familyID', cdr3_col='cdr3nt')#

Compute clonal family diversification (Gini index of clone sizes per sample).

Parameters:

  • df (pandas.DataFrame) – Dataframe containing sample, cluster, and CDR3 columns.

  • sample_col (str) – Column name for sample identifier.

  • cluster_col (str) – Column name for BCR family cluster.

  • cdr3_col (str) – Column name for CDR3 nucleotide sequence.

Returns:

DataFrame with sample-wise clonal family diversification index.

Return type:

pandas.DataFrame

Contents