scanpy.pp.downsample_counts
- scanpy.pp.downsample_counts(adata, counts_per_cell=None, total_counts=None, *, random_state=0, replace=False, copy=False)
Downsample counts from count matrix.
If
counts_per_cellis specified, each cell will downsampled. Iftotal_countsis specified, expression matrix will be downsampled to contain at mosttotal_counts.- Parameters
- adata :
AnnData Annotated data matrix.
- counts_per_cell :
Union[int,Collection[int],None] (default:None) Target total counts per cell. If a cell has more than ‘counts_per_cell’, it will be downsampled to this number. Resulting counts can be specified on a per cell basis by passing an array.Should be an integer or integer ndarray with same length as number of obs.
- total_counts :
Optional[int] (default:None) Target total counts. If the count matrix has more than
total_countsit will be downsampled to have this number.- random_state :
Union[None,int,RandomState] (default:0) Random seed for subsampling.
- replace :
bool(default:False) Whether to sample the counts with replacement.
- copy :
bool(default:False) Determines whether a copy of
adatais returned.
- adata :
- Return type
- Returns
Depending on
copyreturns or updates anadatawith downsampled.X.