theislab / scib

Benchmarking analysis of data integration tools
MIT License
311 stars 63 forks source link

Update documentation clustering #373

Closed mumichae closed 1 year ago

mumichae commented 1 year ago

Addressing the missing documentation for the optimal clustering method

closes #365 closes #366

codecov[bot] commented 1 year ago

Codecov Report

Merging #373 (0ff5f56) into main (57b3389) will not change coverage. The diff coverage is n/a.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #373 +/- ## ======================================= Coverage 53.34% 53.34% ======================================= Files 22 22 Lines 1854 1854 ======================================= Hits 989 989 Misses 865 865 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `53.34% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=theislab#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/theislab/scib/pull/373?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=theislab) | Coverage Δ | | |---|---|---| | [scib/metrics/clustering.py](https://codecov.io/gh/theislab/scib/pull/373?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=theislab#diff-c2NpYi9tZXRyaWNzL2NsdXN0ZXJpbmcucHk=) | `88.11% <ø> (ø)` | |