search

scverse / scanpy

Single-cell analysis in Python. Scales to >1M cells.
https://scanpy.readthedocs.io
BSD 3-Clause "New" or "Revised" License
1.89k stars 594 forks source link

update documentation for scanpy.pl.rank_genes_group #1292

Open rpeys opened 4 years ago

rpeys commented 4 years ago

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.

giovp commented 4 years ago

Hi @rpeys can you please explain in more details what's the issue and show a reproducible example? thank you!

rpeys commented 3 years ago

I am not sure I need a reproducible example to explain this... if you click on the link above that leads you to the documentation for the pl.rank_genes_groups function, you'll there is no description of the 'key' argument for that function. This should be added, so that users know how and when to make use of it. Do you have a specific further question?

giovp commented 3 years ago

good catch! Thank you for reporting this. Pinging @Koncopd since I believe you were involved in major refactoring of this. Thank you @rpeys