README.md

Build Status codecov Build status CRAN version downloads

cRegulome

Overview

Transcription factors and microRNAs are important for regulating the gene expression in normal physiology and pathological conditions. Many bioinformatics tools were built to predict and identify transcription factors and microRNA targets and their role in development of diseases including cancers. The availability of public access high-throughput data allowed for data-driven predictions and discoveries. Here, we build on some of these tools and integrative analyses and provide a tool to access, manage and visualize data from open source databases. cRegulome provides a programmatic access to the regulome (microRNA and transcription factor) correlations with target genes in cancer. The package obtains a local instance of Cistrome Cancer and miRCancerdb databases and provides classes and methods to interact with and visualize the correlation data.

What is cRegulome used for?

cRegulome provides programmatic access to regulome-gene correlation data in cancer from different data sources. Researches who are interested in studying the role of microRNAs and transcription factors in cancer can use this package to construct a small or large scale queries to answer different questions:

In addition, cRegulome can be used with other R packages like igraph to study the co-regulation networks in different types of cancer.

Getting started

To get starting with cRegulome we show a very quick example. We first start by downloading a small test database file, make a simple query and convert the output to a cRegulome object to print and visualize.

# install the package from CRAN
install.packages('cRegulome')
# install the development version from github
devtools::install_github('ropensci/cRegulome')

# install the development version and build vignette from github 
devtools::install_github('ropensci/cRegulome', build_vignettes = TRUE)

```{r load_libraries}

load required libraries

library(cRegulome) library(RSQLite) library(ggplot2)


```r
if(!file.exists('cRegulome.db')) {
    get_db(test = TRUE)
}

# connect to the db file
conn <- dbConnect(SQLite(), 'cRegulome.db')

Or access the same test set file from the package directly

# locate the testset file and connect
fl <- system.file('extdata', 'cRegulome.db', package = 'cRegulome')
conn <- dbConnect(SQLite(), fl)
# enter a custom query with different arguments
dat <- get_mir(conn,
               mir = 'hsa-let-7g',
               study = 'STES',
               min_abs_cor = .3,
               max_num = 5)

# make a cmicroRNA object   
ob <- cmicroRNA(dat)
# print object
ob
# plot object
ob

More

More information and examples of using cRegulome

browseVignettes("cRegulome")

More about the database file here

Citation

citation("cRegulome")



Try the cRegulome package in your browser

Any scripts or data that you put into this service are public.

cRegulome documentation built on Sept. 21, 2018, 6:29 p.m.