From 09ec4aca1f3d3e565bb0fe9d541401b76f54f9d5 Mon Sep 17 00:00:00 2001 From: Mahmoud Ibrahim Date: Mon, 2 Sep 2019 14:56:44 +0200 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2fb5122..8011802 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ genesorteR: Feature Ranking for Single Cell Data ====== -**genesorteR is an R package for single cell data analysis. It calculates a specificity score to rank all genes in each cell cluster. It can then use this ranking to find sets of marker genes or to find highly variable genes.** +**genesorteR is an R package for single cell data analysis. It calculates a specificity score to rank all genes in each cell cluster. It can then use this ranking to find sets of marker genes or to find highly variable or differentially expressed genes. genesorteR is applicable to scRNA-Seq data as well as other sparse single cell data like scATAC-Seq** **genesorteR is relatively quick, just seconds for 100k cells, few minutes for millions of cells. Read more [in genesorteR's pre-print](https://www.biorxiv.org/content/10.1101/676379v1).** +**If you have questions or need help running genesorteR please email us at [this email](http://scr.im/jammpro), we will be happy to help you. For bugs or feature requests, please post [here](https://github.com/mahmoudibrahim/genesorteR/issues).** + genesorteR was developed at the RWTH Aachen University Hospital. -If you have questions or need help running genesorteR please email us at [this email](http://scr.im/jammpro), we will be happy to help you. For bugs or feature requests, please post [here](https://github.com/mahmoudibrahim/genesorteR/issues). + +What genesorteR Can Do +------ +* Rank genes by "specificity" in different clusters in scRNA-Seq data +* Find small sets of marker genes +* Find differentially expressed genes +* Rank open chromatin regions by "specificity" in scATAC-Seq +* Find differentially accessible regions +* Cluster genes/open chromatin regions and make heatmap summaries of single cell data @@ -17,8 +27,6 @@ Install genesorteR #install devtools package from CRAN install.packages("devtools") -library(devtools) - #install genesorteR from the Github repository devtools::install_github("mahmoudibrahim/genesorteR") ``` @@ -44,8 +52,7 @@ pp = plotMarkerHeat(sg$inputMat, sg$inputClass, mm$markers, clusterGenes=TRUE, o pp$gene_class_info #gene clusters ``` - -Also check out the examples in each function's documentation. Vignettes coming soon. +Check [this post](https://github.com/mahmoudibrahim/genesorteR/issues/1) for more info. Also check out the examples in each function's documentation. Vignettes coming soon. Note that genesorteR does not currently accept expression matrices with negative entries.