grassp.pp.filter_proteins#
- filter_proteins(data, *, min_counts=None, min_samples=None, max_counts=None, max_samples=None, inplace=True, min_consecutive=None)[source]#
Filter proteins based on number of counts or samples.
Only one criterion can be given per call, as in
scanpy.pp.filter_cells().- Parameters:
- data
Union[AnnData,spmatrix,ndarray,Array] The annotated data matrix of shape n_obs x n_vars. Rows correspond to proteins and columns to samples.
- min_counts
int|None(default:None) Minimum number of counts required for a protein to pass filtering.
- min_samples
int|None(default:None) Minimum number of samples expressed required for a protein to pass filtering.
- max_counts
int|None(default:None) Maximum number of counts required for a protein to pass filtering.
- max_samples
int|None(default:None) Maximum number of samples expressed required for a protein to pass filtering.
- inplace
bool(default:True) Perform computation inplace or return result.
- min_consecutive
int|None(default:None) (If using fractionation instead of organellar IP) Minimum number of consecutive fractions that a protein is present in; see
filter_min_consecutive_fractions(). Requires an AnnData.
- data
- Return type:
- Returns:
Depending on
inplaceand input type, returns either:Noneifinplace=TrueA tuple of arrays
(retained_proteins, retained_samples)ifinplace=FalseA boolean mask of retained proteins for
min_consecutivewithinplace=False
Examples
>>> import grassp as gr >>> adata = gr.datasets.hein_2024(enrichment="raw") >>> adata.shape (8538, 183) >>> gr.pp.filter_proteins(adata, min_samples=5) >>> adata.shape # Fewer proteins after filtering (8358, 183)