search

YosefLab / scib-metrics

Accelerated, Python-only, single-cell integration benchmarking metrics
https://scib-metrics.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
45 stars 11 forks source link

Incorrect return type in the documentation for ilisi/clisi #113

Open timtreis opened 11 months ago

timtreis commented 11 months ago

Report

Extremely minor but I'm currently extracting a few bits from "under the hood". Noticed that the return type of the ilisi_knn and clisi_knn calculations are incorrect. According to https://scib-metrics.readthedocs.io/en/stable/generated/scib_metrics.ilisi_knn.html it's ilisi Array of shape (n_cells,) with the iLISI score for each cell. but due to https://github.com/YosefLab/scib-metrics/blob/9d109007d8b78ad2678342db6630cc355cfd1d0b/src/scib_metrics/_lisi.py#L66 it's a single float. Analog for clisi

Version information

No response

adamgayoso commented 8 months ago

Thanks! Happy to accept a PR with the change