update documentation for scanpy.pl.rank_genes_group
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 779
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 27
Description
A description of the "key" argument is missing from the documentation for the rank_genes_groups plotting function located at https://scanpy.readthedocs.io/en/stable/api/scanpy.pl.rank_genes_groups.html#scanpy.pl.rank_genes_groups. Without this, it's unclear how to plot the results of an alternative differential expression analysis (which is not stored in uns.rank_genes_groups). Would be great to update the documentation to include it.
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 with the scanpy.pl.rank_genes_group API documentation at the linked page and inspect the existing argument descriptions. Document how the key argument supports plotting results from an alternative differential expression analysis rather than only uns.rank_genes_group; the page should clearly explain that usage when done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100