Is more documentation planned?
ljschumacher opened this issue · comments
Are you planning on extending the documentation of this version? It's a great tool, but the technical side of the documentation is a bit sparse, both in the README, the source code, and the web front-end. Some details have clearly changed from the publication, and it required some effort for the user to understand what's going on.
For example, is there a reference for the v-score filtering of genes? From the code it's clear that it's filtering based on the distribution of variability, but what is the quantity being calculated from the fano factors? It's also not so clear to the less technically versed front-end user whether to in- or decrease that parameter based on its name, so more documentation could be useful here.
Nice resource. Request an expansion on Setting up a SPRING data directory in the documentation as well (or maybe some smaller example datasets). At the moment there are a lot of files required, but minimal descriptions about them.