FACSPy.remove_channel

Contents

FACSPy.remove_channel#

FACSPy.remove_channel(adata, channel, as_view=False, copy=False)#

Removes a channel from the dataset. This function will only subset the AnnData object. Use in conjunction with fp.sync.synchronize_dataset() to update the analyzed data and the accompanying metadata with it.

Parameters:

  • adata (AnnData) – The anndata object of shape n_obs x n_vars where rows correspond to cells and columns to the channels.

  • channel (Union[list[str], str]) – The channel to remove. Has to be in adata.var_names. Pass a list of channels to subset multiple channels at once.

  • as_view (bool) – If True, returns an AnnDataView object.

  • copy (bool) – Whether to copy the dataset.

Return type:

AnnData or None, depending on copy.

Examples

>>> import FACSPy as fp
>>> dataset = fp.create_dataset(...)
>>> fp.remove_channel(dataset, "CD16")
Contents