Conversation
mikkelnrasmussen
left a comment
There was a problem hiding this comment.
Hi @remydubois,
Thanks for submitting illico, it looks like a really nice tool! In general the package looks good, however I have one comment regarding API documentation. By API documentation, we mean a structured listing of all functions/classes/methods, including their arguments and expected inputs/outputs. A good example is the scirpy API docs. I recommend looking into Sphinx Autodoc plugin to generate this kind of documentation. I was not able to find this kind of API documentation for the package.
Looking forward to hearing from you.
Best regards,
Mikkel
|
Hi, Thanks for looking into this. I agree an API doc would be helpful. Because only one function is meant at being user facing ( Rémy |
Mandatory
Name of the tool: illico
Short description: illico runs fast, CPU-based, wilcoxon rank-sum tests to identify differentially expressed genes for single-cell RNA-seq data.
How does the package use scverse data structures (please describe in a few sentences): illico uses AnnData objects as input data. It uses .X or .layers to read expression counts, and .obs to get the grouping variable.
Recommended
Please tag the author(s) these announcements. Handles (e.g. @scverse_team) to include are:
Zulip: @remydubois, post is here: #announce > illico: x100 faster rank-sum tests on CPU in python @ 💬
The package provides tutorials (or "vignettes") that help getting users started quickly
The package uses the scverse cookiecutter template.