Skip to content

Commit 4f169ed

Browse files
committed
readjust
1 parent fc77552 commit 4f169ed

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<p align="center">
44

5-
<img src="docs/HiTME_logo.png" height="100"/>
5+
<img src="docs/HiTME_logo.png" height="140"/>
66

77
</p>
88

@@ -12,30 +12,36 @@ HiTME is designed for precise cell type classification within the complex tumor
1212

1313
Find a vignette describing its main functions in [html](https://carmonalab.github.io/HiTME_CaseStudies/HiTME_GetStarted.html) and its [code (repository)](https://github.com/carmonalab/HiTME_CaseStudies).
1414

15+
<br>
16+
1517
## Installation
1618

1719
``` r
1820
# install.packages("remotes")
1921
remotes::install_github("carmonalab/HiTME")
2022
```
2123

24+
<br>
25+
2226
## Usage
2327

2428
``` r
2529
library(ProjecTILs)
2630
library(HiTME)
2731

2832
# Fetch reference maps
29-
ref.maps <- ref.maps <- get.reference.maps(collection = "human")
33+
ref.maps <- get.reference.maps(collection = "human")
3034

3135
# Cell type classification on a Seurat object
3236
query <- Run.HiTME(query,
3337
ref.maps = ref.maps[["human"]])
3438

35-
# Seurat object metadata has been updated with cell type classification at different granularity levels (layers)
39+
# Seurat object metadata has been updated with cell type classification at
40+
# different granularity levels (layers)
3641
```
42+
<br>
3743

38-
### How to cite HiTME
44+
## How to cite HiTME
3945
Please note that the publication describing HiTME is currently in preparation. In the meantime, we kindly ask that you cite the two primary components of HiTME in your work:
4046

4147
- [scGate](https://github.com/carmonalab/scGate): Andreatta, Massimo, Ariel J. Berenstein, and Santiago J. Carmona. 2022. “scGate: Marker-Based Purification of Cell Types from Heterogeneous Single-Cell RNA-Seq Datasets.” Bioinformatics 38 (April): 2642–44. https://doi.org/10.1093/BIOINFORMATICS/BTAC141.

0 commit comments

Comments
 (0)