Merge branch 'master' of https://github.com/theislab/diffxpy

README.md

@@ -10,6 +10,9 @@ diffxpy covers a wide range of differential expression analysis scenarios encoun
 3. cd into the clone.
 4. pip install -e .
 
+# Examples
+We provide usage example cases (vignettes) in the ~/examples/ directory. The diffxpy API distinguishes two cases: Single-tests and Mult-tests. Single-test wrappers perform a single tests per gene, such as a difference between two groups via a Wald test, a log-likelihood ratio test, a t-test or a Wilcoxon rank sum test or a log-likelihood ratio test for a more complex question. A multi-test wrapper performs multiple tests per gene: pairwise or 1-versus-rest tests. Both are a series of two-sample tests for each gene which can for example be used to explore the differences between louvain groups on the level of each gene. Pairwise tests perform one test for the difference between each pair of groups of cells for each gene (which can be significantly sped up if the test mode 'z-test' is used). 1-versus-rest tests test for the difference between each group and the other groups together for each gene.
+
 # Building the documentation
 The documentation is maintained in the `docs/` directory.