scverse / scverse/scirpy

Refactor distance metric histogram

Open
#548 0 comments 0 reactions 1 assignee View on GitHub

@felixpetschko is already working on this.

Since Aug 30, 2024.

breaking-change
Dominant language
Python
Stars
265
Forks
50
Avg merge
9d 9h
Merged PRs (30d)
4

Description

Follow up on https://github.com/scverse/scirpy/pull/512

  • Instead of directly plotting a the histogram from ir_dist, store the histogram in AnnData.uns
  • Add a separate plotting function pl.ir_dist_histogram to visualize the data. Align the function signature with other scirpy plotting functions
  • Implement the generation of the histogram for all metrics. Adjust the base classes and implementations accordingly. Make sure that the overhead stays as small as possible.
  • Before starting, measure the baseline performance of the distance metrics on the 3k example dataset. At the end compare the runtime to ensure the overhead is minimal.
  • Update the tutorial to reflect the changes

This change is to be consistent with the rest of the interface, and potentially being able to customize the plot, without rerunning the entire calculation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.