-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
66 lines (44 loc) · 2.34 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
title: "Cepo"
output: github_document
---
<img src="man/figures/Cepo_logo.png" align="right" width="225" height="250"/>
 [](https://codecov.io/gh/PYangLab/Cepo)
Defining the identity of a cell is fundamental to understand the heterogeneity of cells to various environmental signals and perturbations. We present Cepo, a new method to explore cell identities from single-cell RNA-sequencing data using differential stability as a new metric to define cell identity genes. Cepo computes cell-type specific gene statistics pertaining to differential stable gene expression.
## Installation
You can install the development version of _Cepo_ that can be installed from GitHub
using the `remotes` package:
``` r
# install.packages("remotes")
remotes::install_github("PYangLab/Cepo")
```
You can install the Bioconductor version of _Cepo_ from:
``` r
if (!requireNamespace("BiocManager", quietly = TRUE))
install.packages("BiocManager")
BiocManager::install("Cepo")
```
To also build the vignettes use:
``` r
# install.packages("remotes")
remotes::install_github("PYangLab/Cepo", dependencies = TRUE,
build_vignettes = TRUE)
```
**NOTE:** Building the vignettes requires the installation of additional
packages.
## Documentation
The documentation for _Cepo_ is available from http://github.io/PYangLab/Cepo
To view the vignette and all the package documentation for the development
version visit http://github.io/PYangLab/Cepo.
## Citing _Cepo_
If you use *Cepo* in your work please cite our preprint ["Kim H.J., Wang
K., Yang P. Cepo uncovers cell identity through
differential stability. bioRxiv DOI:](add%20biorxiv%20link).
To find all source code related to the anlayses of our preprint please refer to <http://github.io/PYangLab/CepoManuscript>.
## Developers
The following individuals were involved in developing the Cepo package:
* [@HaniJieunKim](https://github.com/HaniJieunKim)
* [@kevinwang09](https://github.com/kevinwang09)
* [@PYangLab](https://github.com/PYangLab)
## Contact us
If you have any enquiries, especially about using Cepo to analyse your data, please contact hani.kim@sydney.edu.au. We actively welcome any feedback and suggestions!