scanpy.external.pp.bbknn
- scanpy.external.pp.bbknn(adata, batch_key='batch', use_rep='X_pca', approx=True, use_annoy=True, metric='euclidean', copy=False, *, neighbors_within_batch=3, n_pcs=50, trim=None, annoy_n_trees=10, pynndescent_n_neighbors=30, pynndescent_random_state=0, use_faiss=True, set_op_mix_ratio=1.0, local_connectivity=1, **kwargs)
Batch balanced kNN [Polanski19].
Batch balanced kNN alters the kNN procedure to identify each cell’s top neighbours in each batch separately instead of the entire cell pool with no accounting for batch. The nearest neighbours for each batch are then merged to create a final list of neighbours for the cell. Aligns batches in a quick and lightweight manner.
For use in the scanpy workflow as an alternative to
neighbors()
.Note
This is just a wrapper of
bbknn.bbknn()
: up to date docstring, more information and bug reports there.- Parameters
- adata
Needs the PCA computed and stored in
adata.obsm["X_pca"]
.- batch_key
adata.obs
column name discriminating between your batches.- use_rep
The dimensionality reduction in
.obsm
to use for neighbour detection. Defaults to PCA.- approx
If
True
, use approximate neighbour finding - annoy or pyNNDescent. This results in a quicker run time for large datasets while also potentially increasing the degree of batch correction.- use_annoy
Only used when
approx=True
. IfTrue
, will use annoy for neighbour finding. IfFalse
, will use pyNNDescent instead.- metric
What distance metric to use. The options depend on the choice of neighbour algorithm.
”euclidean”, the default, is always available.
Annoy supports “angular”, “manhattan” and “hamming”.
PyNNDescent supports metrics listed in
pynndescent.distances.named_distances
and custom functions, including compiled Numba code.>>> pynndescent.distances.named_distances.keys() dict_keys(['euclidean', 'l2', 'sqeuclidean', 'manhattan', 'taxicab', 'l1', 'chebyshev', 'linfinity', 'linfty', 'linf', 'minkowski', 'seuclidean', 'standardised_euclidean', 'wminkowski', 'weighted_minkowski', 'mahalanobis', 'canberra', 'cosine', 'dot', 'correlation', 'hellinger', 'haversine', 'braycurtis', 'spearmanr', 'kantorovich', 'wasserstein', 'tsss', 'true_angular', 'hamming', 'jaccard', 'dice', 'matching', 'kulsinski', 'rogerstanimoto', 'russellrao', 'sokalsneath', 'sokalmichener', 'yule'])
KDTree supports members of the
sklearn.neighbors.KDTree.valid_metrics
list, or parameterisedsklearn.neighbors.DistanceMetric
objects:>>> sklearn.neighbors.KDTree.valid_metrics ['p', 'chebyshev', 'cityblock', 'minkowski', 'infinity', 'l2', 'euclidean', 'manhattan', 'l1']
- copy
If
True
, return a copy instead of writing to the supplied adata.- neighbors_within_batch
How many top neighbours to report for each batch; total number of neighbours in the initial k-nearest-neighbours computation will be this number times the number of batches. This then serves as the basis for the construction of a symmetrical matrix of connectivities.
- n_pcs
How many dimensions (in case of PCA, principal components) to use in the analysis.
- trim
Trim the neighbours of each cell to these many top connectivities. May help with population independence and improve the tidiness of clustering. The lower the value the more independent the individual populations, at the cost of more conserved batch effect. If
None
, sets the parameter value automatically to 10 timesneighbors_within_batch
times the number of batches. Set to 0 to skip.- annoy_n_trees
Only used with annoy neighbour identification. The number of trees to construct in the annoy forest. More trees give higher precision when querying, at the cost of increased run time and resource intensity.
- pynndescent_n_neighbors
Only used with pyNNDescent neighbour identification. The number of neighbours to include in the approximate neighbour graph. More neighbours give higher precision when querying, at the cost of increased run time and resource intensity.
- pynndescent_random_state
Only used with pyNNDescent neighbour identification. The RNG seed to use when creating the graph.
- use_faiss
If
approx=False
and the metric is “euclidean”, use the faiss package to compute nearest neighbours if installed. This improves performance at a minor cost to numerical precision as faiss operates on float32.- set_op_mix_ratio
UMAP connectivity computation parameter, float between 0 and 1, controlling the blend between a connectivity matrix formed exclusively from mutual nearest neighbour pairs (0) and a union of all observed neighbour relationships with the mutual pairs emphasised (1)
- local_connectivity
UMAP connectivity computation parameter, how many nearest neighbors of each cell are assumed to be fully connected (and given a connectivity value of 1)
- Returns
The
adata
with the batch-corrected graph.