scanpy.api.pp.subsample

scanpy.api.pp.subsample(data, fraction=None, n_obs=None, random_state=0, copy=False)

Subsample to a fraction of the number of observations.

Parameters
data : AnnData, np.ndarray, sp.sparse

The (annotated) data matrix of shape n_obs × n_vars. Rows correspond to cells and columns to genes.

fraction : float in [0, 1] or None, optional (default: None)

Subsample to this fraction of the number of observations.

n_obs : int or None, optional (default: None)

Subsample to this number of observations.

random_state : int or None, optional (default: 0)

Random seed to change subsampling.

copy : bool, optional (default: False)

If an AnnData is passed, determines whether a copy is returned.

Return type

AnnData, NoneOptional[AnnData]

Returns

Returns X[obs_indices], obs_indices if data is array-like, otherwise subsamples the passed AnnData (copy == False) or returns a subsampled copy of it (copy == True).