Skip to content

Commit c110b07

Browse files
committed
Update readme
1 parent da5092e commit c110b07

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@
44
<img height="80" src="inst/RSticker_SCGATE.png">
55
</p>
66

7-
**scGate** is an R package that automatizes the typical manual marker-based approach to cell type annotation, to enable accurate and intuitive purification of a cell population of interest from a complex scRNA-seq dataset, **without requiring reference gene expression profiles or training data**. scGate works with any scRNA-seq technology and with other single-cell modalities.
7+
**scGate** is an R package that automatizes the typical manual marker-based approach to cell type annotation, to enable accurate and intuitive purification of a cell population of interest from a complex scRNA-seq dataset, **without requiring reference gene expression profiles or training data**. **scGate** works with any scRNA-seq technology and with other single-cell modalities.
88

9-
scGate builds upon [UCell](https://github.com/carmonalab/UCell) for robust single-cell signature scoring and [Seurat](https://github.com/satijalab/seurat/), a comprehensive and powerful framework for single-cell omics analysis.
9+
**scGate** builds upon [UCell](https://github.com/carmonalab/UCell) for robust single-cell signature scoring and [Seurat](https://github.com/satijalab/seurat/), a comprehensive and powerful framework for single-cell omics analysis.
1010

11-
Briefly, scGate takes as input: *i)* a gene expression matrix stored in a Seurat object and *ii)* a “gating model” (GM), consisting of a set of marker genes that define the cell population of interest. The GM can be as simple as a single marker gene, or a combination of positive and negative markers. More complex GMs can be constructed in a hierarchical fashion, akin to gating strategies employed in flow cytometry.
11+
Briefly, **scGate** takes as input: *i)* a gene expression matrix stored in a Seurat object and *ii)* a “gating model” (GM), consisting of a set of marker genes that define the cell population of interest. The GM can be as simple as a single marker gene, or a combination of positive and negative markers. More complex GMs can be constructed in a hierarchical fashion, akin to gating strategies employed in flow cytometry.
1212

13-
scGate evaluates the strength of signature marker expression in each cell using the rank-based method UCell, and then performs k-nearest neighbor (kNN) smoothing by calculating the mean UCell score across neighboring cells. kNN-smoothing aims at compensating for the large degree of sparsity in scRNA-seq data. Finally, a universal threshold over kNN-smoothed signature scores is applied in binary decision trees generated from the user-provided gating model, to annotate cells as either “pure” or “impure”, with respect to the cell population of interest.
13+
**scGate** evaluates the strength of signature marker expression in each cell using the rank-based method UCell, and then performs k-nearest neighbor (kNN) smoothing by calculating the mean UCell score across neighboring cells. kNN-smoothing aims at compensating for the large degree of sparsity in scRNA-seq data. Finally, a universal threshold over kNN-smoothed signature scores is applied in binary decision trees generated from the user-provided gating model, to annotate cells as either “pure” or “impure”, with respect to the cell population of interest.
1414

1515
![scGate_examples](https://github.com/carmonalab/scGate.demo/blob/master/docs/scGate_example.png?raw=true)
1616

1717

1818
### Installation
1919

20-
Install `scGate` from [CRAN](https://cran.r-project.org/web/packages/scGate/index.html)
20+
Install **scGate** from [CRAN](https://cran.r-project.org/web/packages/scGate/index.html)
2121
```r
2222
install.packages("scGate")
2323
```
2424

25-
For older versions of `scGate`, download a tagged version from GitHub:
25+
For older versions of **scGate**, download a tagged version from GitHub:
2626
```r
2727
library(remotes)
2828
remotes::install_github("carmonalab/scGate", ref="v1.2.0")
2929
```
3030

3131
### Testing the package
3232

33-
Use scGate to purify a cell population of interest using manually defined marker genes
33+
Use **scGate** to purify a cell population of interest using manually defined marker genes
3434

3535
```r
3636
library(scGate)
@@ -54,7 +54,7 @@ seurat_object_purified <- subset(seurat_object, subset = `is.pure` == "Pure" )
5454
```
5555
### Demos and tutorials
5656

57-
Check out this [scGate demo](https://carmonalab.github.io/scGate.demo) for a reproducible analysis, construction of hierarchical gating models, tools for performance evaluation and other advanced features. More demos for running scGate on different single-cell modalities are available at [scGate.demo repository](https://github.com/carmonalab/scGate.demo).
57+
Check out this [scGate demo](https://carmonalab.github.io/scGate.demo) for a reproducible analysis, construction of hierarchical gating models, tools for performance evaluation and other advanced features. More demos for running **scGate** on different single-cell modalities are available at [scGate.demo repository](https://github.com/carmonalab/scGate.demo).
5858

5959
### Pre-defined Gating Models
6060

@@ -84,18 +84,18 @@ scGate::plot_tree(scGate_models_DB$human$generic$Tcell.alphabeta)
8484

8585
### scGate as a multi-class classifier
8686

87-
scGate can also be used a cell type classifier, to annotate multiple cell types in a dataset. To annotate a dataset with marker-based cell type definitions, simply provide a list of models to scGate, e.g.:
87+
**scGate** can also be used a cell type classifier, to annotate multiple cell types in a dataset. To annotate a dataset with marker-based cell type definitions, simply provide a list of models to **scGate**, e.g.:
8888

8989
```r
9090
models.list <- scGate_models_DB$human$generic[c("Bcell","MoMacDC","CD8T","CD4T","Erythrocyte")]
9191
obj <- scGate(obj, model = models.list)
9292
```
9393

94-
See examples of scGate as a classifier at: [scGate multi-class](https://carmonalab.github.io/scGate.demo/#scgate-as-a-multi-class-classifier) and [scGate on integrated objects](https://carmonalab.github.io/scGate.demo/scGate.integrated.html)
94+
See examples of **scGate** as a classifier at: [scGate multi-class](https://carmonalab.github.io/scGate.demo/#scgate-as-a-multi-class-classifier) and [scGate on integrated objects](https://carmonalab.github.io/scGate.demo/scGate.integrated.html)
9595

9696

9797
### Other single-cell modalities
98-
scGate can be applied to modalities other than RNA-seq, such as ATAC-seq ([scATAC-seq demo](https://carmonalab.github.io/scGate.demo/scGate.ATAC-seq.html)) and antibody-derived tags (ADT) ([CITE-seq demo](https://carmonalab.github.io/scGate.demo/scGate.CITE-seq.html)).
98+
**scGate** can be applied to modalities other than RNA-seq, such as ATAC-seq ([scATAC-seq demo](https://carmonalab.github.io/scGate.demo/scGate.ATAC-seq.html)) and antibody-derived tags (ADT) ([CITE-seq demo](https://carmonalab.github.io/scGate.demo/scGate.CITE-seq.html)).
9999

100100
### References
101101

0 commit comments

Comments
 (0)