From eb7300a4a085f711733272122be340d3e6df9efb Mon Sep 17 00:00:00 2001 From: Severin Dicks <37635888+Intron7@users.noreply.github.com> Date: Mon, 4 Nov 2024 17:23:08 +0100 Subject: [PATCH] Update src/rapids_singlecell/preprocessing/_neighbors.py Co-authored-by: Philipp A. --- src/rapids_singlecell/preprocessing/_neighbors.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/rapids_singlecell/preprocessing/_neighbors.py b/src/rapids_singlecell/preprocessing/_neighbors.py index 853ae153..7aea8c86 100644 --- a/src/rapids_singlecell/preprocessing/_neighbors.py +++ b/src/rapids_singlecell/preprocessing/_neighbors.py @@ -490,7 +490,13 @@ def bbknn( metric_kwds Options for the metric. 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 times `neighbors_within_batch` times the number of batches. Set to 0 to skip. + 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 times `neighbors_within_batch` times the number of batches. + Set to 0 to skip. key_added If not specified, the neighbors data is stored in `.uns['neighbors']`, distances and connectivities are stored in `.obsp['distances']` and