-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.Rmd
72 lines (55 loc) · 2.96 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#"
)
```
# BioNERO <img src='man/figures/logo.png' align="right" height="139" />
<!-- badges: start -->
[![GitHub issues](https://img.shields.io/github/issues/almeidasilvaf/BioNERO)](https://github.com/almeidasilvaf/BioNERO/issues)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check-bioc](https://github.com/almeidasilvaf/BioNERO/workflows/R-CMD-check-bioc/badge.svg)](https://github.com/almeidasilvaf/BioNERO/actions)
[![Codecov test coverage](https://codecov.io/gh/almeidasilvaf/BioNERO/branch/devel/graph/badge.svg)](https://codecov.io/gh/almeidasilvaf/BioNERO?branch=devel)
<!-- badges: end -->
`BioNERO` aims to integrate all aspects of biological network inference
in a single package, so users don't have to learn the syntaxes of several
packages and how to communicate among them. `BioNERO` features:
- **Expression data preprocessing** using state-of-the-art techniques for
network inference.
- **Automated exploratory data analyses**, including principal component
analysis (PCA) and heatmaps of gene expression or sample correlations.
- **Inference of gene coexpression networks (GCNs)** using the popular WGCNA
algorithm.
- **Inference of gene regulatory networks (GRNs)** based on the "wisdom
of the crowds" principle. This principle consists in inferring GRNs with
multiple algorithms (here, CLR, GENIE3 and ARACNE) and calculating
the average rank for each interaction pair.
- **Exploration of network topology** of GCNs, GRNs, and protein-protein
interaction networks.
- **Network visualization**.
- **Network comparison**, including identification of consensus modules
across independent expression sets, and calculation of intra and interspecies
module preservation statistics between different networks.
## Installation instructions
Get the latest stable `R` release from [CRAN](http://cran.r-project.org/). Then install `BioNERO` from [Bioconductor](http://bioconductor.org/) using the following code:
```{r 'install', eval = FALSE}
if (!requireNamespace("BiocManager", quietly = TRUE)) {
install.packages("BiocManager")
}
BiocManager::install("BioNERO")
```
And the development version from [GitHub](https://github.com/almeidasilvaf/BioNERO) with:
```{r 'install_dev', eval = FALSE}
BiocManager::install("almeidasilvaf/BioNERO")
```
## Citation
Below is the citation output from using `citation('BioNERO')` in R. Please
run this yourself to check for any updates on how to cite __BioNERO__.
```{r 'citation', eval = requireNamespace('BioNERO')}
print(citation('BioNERO'), bibtex = TRUE)
```
Please note that the `BioNERO` was only made possible thanks to many other R and bioinformatics software authors, which are cited either in the vignettes and/or the paper(s) describing this package.