scirpy.io.IrCell¶
-
class
scirpy.io.
IrCell
(cell_id, *, multi_chain=False)¶ Data structure for a Cell with immune receptors.
An IrCell can hold multiple IrChains.
- Parameters
- cell_id :
str
str
cell id or barcode. Needs to match the cell id used for transcriptomics data (i.e. the
adata.obs_names
)- multi_chain :
bool
bool
(default:False
) explicitly mark this cell as Multichain-cell. Even if this is set to
False
,scirpy.io.from_ir_objs()
will consider the cell as multi chain, if it has more than two VJ or VDJ chains. However, if this is set toTrue
, the function will consider it as multi-chain regardless of the number of chains.
- cell_id :
Attributes
Methods
add_chain
(chain)Add a
IrChain