anndict.utils.pca_density_filter_adata

anndict.utils.pca_density_filter_adata(adata, use_layer=None, new_filter_column_name='density_filter', drop_cells=False, **kwargs)

Filters pca_density_filter() that accepts AnnData as input.

Parameters:

adata AnnData

An AnnData.

use_layer str | None (default: None)

name of the layer to use for PCA (default: None, use adata.X).

new_filter_column_name str (default: 'density_filter')

Name of the new boolean column to be created in adata.obs.

**kwargs

Additional keyword arguments to pass to pca_density_filter_main().

drop_cells bool

Returns:

If drop_cells is True, returns a new AnnData with the filtered cells. Otherwise, modifies adata in-place by adding a boolean masking column.