search

scverse / scirpy

A scanpy extension to analyse single-cell TCR and BCR data.
https://scirpy.scverse.org/en/latest/
BSD 3-Clause "New" or "Revised" License
220 stars 34 forks source link

Unclear default value for the Hamming Distance cut-off #471

Closed FFinotello closed 10 months ago

FFinotello commented 10 months ago

Hi @grst!

I think it is not clear from the API documentation of the HammingDistanceCalculator whether the default of the cutoff parameter is None or 2:

image
grst commented 10 months ago

Good catch! Actually both is true -- cutoff=None is the default value, but if cutoff is None, a default of 2 is selected. Clearly the documentation needs to be improved.