-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
66 lines (43 loc) · 1.57 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
---
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%"
)
```
# miRminer
<!-- badges: start -->
[![R build status](https://github.com/jvfe/miRminer/workflows/R-CMD-check/badge.svg)](https://github.com/jvfe/miRminer/actions)
[![license](https://img.shields.io/badge/license-MIT-lightgrey)](https://github.com/jvfe/miRminer/blob/master/LICENSE.md)
<!-- badges: end -->
Scrapes disease-associated miRNA data.
Databases of miRNA-disease association, like [HMDD](https://www.cuilab.cn/hmdd) or [miRTarBase](https://mirtarbase.cuhk.edu.cn/php/), provide
easily downloadable data dumps, but no easy way to query it programmatically, such
as an API, this package exists to alleviate some of those issues.
## Installation
You can install the latest version of miRminer from Github with:
```{r install_github, eval=FALSE}
install.packages("remotes")
remotes::install_github("jvfe/miRminer")
```
## Example usage
If you want to get causality information from HMDD3:
```{r hmdd-causal, eval=FALSE}
library(miRminer)
sepsis_causal <- get_hmdd_causality("sepsis")
hm101_causal <- get_hmdd_causality("hsa-mir-101")
```
Or miRNA-target interaction networks:
```{r hmdd-net, eval=FALSE}
silicosis_net <- get_hmdd_net("silicosis")
hm101_net <- get_hmdd_net("hsa-mir-101")
```
Or maybe miRNA-disease association from mirTarBase:
```{r mirtar-examp, eval=FALSE}
carcinoma_mirnas <- get_mirtar_disease("carcinoma")
```