scirpy.tl.chain_pairing

scirpy.tl.chain_pairing(adata, *, inplace=True, key_added='chain_pairing')

Categorize cells based on how many TRA and TRB chains they have.

Parameters

adata : AnnDataAnnData

Annotated data matrix

inplace : boolbool (default: True)

If True, adds a column to adata.obs

key_added : strstr (default: 'chain_pairing')

Column name to add to ‘obs’

Return type

None, ndarrayOptional[ndarray]

Returns

Depending on the value of inplace, either returns a Series with a chain pairing category for each cell or adds a chain_pairing column to adata.