scirpy.io.to_airr_cells

Contents

scirpy.io.to_airr_cells#

scirpy.io.to_airr_cells(adata, *, airr_mod='airr', airr_key='airr')#

Convert an adata object with IR information back to a list of AirrCell objects. Inverse function of from_airr_cells().

Parameters:
  • adata (Union[AnnData, MuData, DataHandler]) – AnnData or MuData object that contains AIRR information.

  • airr_mod (str (default: 'airr')) – Name of the modality with AIRR information is stored in the MuData object. if an AnnData object is passed to the function, this parameter is ignored.

  • airr_key (str (default: 'airr')) – Key under which the AIRR information is stored in adata.obsm as an awkward array.

Return type:

list[AirrCell]

Returns:

List of AirrCell objects.