pytometry.pp.split_signal

Contents

pytometry.pp.split_signal#

pytometry.pp.split_signal(adata, var_key=None, key='signal_type', option='area', data_type='facs', inplace=True)#

Method to filter out height or area data.

Parameters:

  • adata (AnnData) – AnnData object containing data.

  • var_key (str | None (default: None)) – Key where to check if a feature is an area, height etc. type of value. Use var_names if None.

  • key (str (default: 'signal_type')) – Key for adata.var where the variable type is stored.

  • option (str (default: 'area')) – For choosing ‘area’ or ‘height’ in case of FACS data and ‘element’ for cyTOF data.

  • data_type (Literal['facs', 'cytof'] (default: 'facs')) – Type of cytometry data

  • inplace (bool (default: True)) – Update adata and return None if True. Otherwise, return a copy of adata with the changes.

Return type:

AnnData | None

Returns:

Depending on inplace, returns or updates adata with area or height data in .var

Contents