Restructure repertoire overlap functions
Open
Nobody has claimed this yet.
breaking-change
- Dominant language
- Python
- Stars
- 265
- Forks
- 50
- Avg merge
- 9d 9h
- Merged PRs (30d)
- 4
Description
I suggest to restructure the repertoire overlap functions a little:
-
split up heatmap and pairwise plot into two plotting functions
- e.g.
repertoire_overlap_heatmapandrepertoire_overlap_pairwise. Like that it's clearer what they do and they can be show in the API with two separate images
- e.g.
-
make it more transparent what the
toolstores. Maybe store the parameters in uns to automatically recompute when they changed.
Other improvements:
- label which color bar in the heatmap shows which variable
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the repertoire overlap plotting functions and inspecting what the tool stores in uns. Separate heatmap and pairwise plotting, make the stored parameters transparent or recomputable, and label each heatmap color bar; verify the resulting API presentation and plots.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100