forked from jiang-junyao/IReNA
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
78 lines (53 loc) · 3.29 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
67
68
69
70
71
72
73
74
75
76
77
78
---
title: "IReNA: integrated regulatory network analysis of single-cell transcriptomes"
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
`r badger::badge_custom("r", "version4.04", "green", "https://www.r-project.org")`
`r badger::badge_custom("Seurat", "version4.01", "red", "https://satijalab.org/seurat/articles/get_started.html")`
`r badger::badge_custom("monocle", "version2.18", "blue", "http://cole-trapnell-lab.github.io/monocle-release")`
`r badger::badge_custom("Preprint", "biorxiv", "purple", "https://doi.org/10.1101/2021.11.22.469628")`
IReNA (Integrated Regulatory Network Analysis) is an R package to perform regulatory network analysis. IReNA contains two methods to reconstruct gene regulatory networks. The first is using single-cell RNA sequencing (scRNA-seq) data alone. The second is integrating scRNA-seq data and chromatin accessibility profiles from Assay for Transposase Accessible Chromatin using sequencing (scATAC-seq or bulk ATAC-seq). IReNA performs modular regulatory network to reveal key transcription factors and significant regulatory relationships among modules, providing biological insights on regulatory mechanisms.
## Workflow
![](docs/Readme figure/Workflow1.png){ width=80% height=80% }
## Installation
IReNA needs R version 4.0 or higher, and [Bioconductor](http://bioconductor.org/) version 3.12.
First, install Bioconductor, open R platform and run:
```r
if (!requireNamespace("BiocManager", quietly = TRUE))
install.packages("BiocManager")
BiocManager::install(version = "3.12")
```
Next, install several Bioconductor dependencies:
```r
BiocManager::install(c('Rsamtools', 'ChIPseeker', 'monocle',
'RcisTarget', 'RCy3', 'clusterProfiler'))
```
Then, install IReNA from GitHub:
```r
install.packages("devtools")
devtools::install_github("jiang-junyao/IReNA")
```
Finally, check whether IReNA was installed correctly, restart R session and run:
```r
library(IReNA)
```
## Examples and tutorials
* [Regulatory network analysis through only scRNA-seq data](https://jiang-junyao.github.io/IReNA/only-scRNA)
* [Regulatory network analysis through intergrating scRNA-seq data and scATAC-seq data](https://jiang-junyao.github.io/IReNA/scATAC+scRNA)
* [Regulatory network analysis through intergrating scRNA-seq data and bulk ATAC-seq data](https://jiang-junyao.github.io/IReNA/bulk-ATAC+scRNA)
## External links
An example for [using IReNA to identify transcription factors critical for retinal regeneration](https://github.com/jiewwwang/Single-cell-retinal-regeneration)
## Citation
Preprint: [IReNA: integrated regulatory network analysis of single-cell transcriptomes](https://doi.org/10.1101/2021.11.22.469628)
[Hoang T, Wang J, Boyd P, et al. Gene regulatory networks controlling vertebrate retinal regeneration. Science 2020; 370(6519):eabb8598](https://www.science.org/doi/10.1126/science.abb8598)
## Help and Suggestion
If you have any question, comment or suggestion, please use github issue tracker to report issues of IReNA or contact <[email protected]>. I will answer you timely, and please remind me again if you have not received response more than three days.