README.md

In xQTLbiolinks: An R Package for Integrative Analysis of Quantitative Trait Locus Data of 'xQTL'

xQTLbiolinks: a comprehensive and scalable tool for integrative analysis of molecular QTLs

xQTLbiolinks is a end-to-end bioinformatic tool for efficient mining and analyzing public and user-customized xQTLs data for the discovery of disease susceptibility genes. xQTLbiolinks consists of tailored functions that can be grouped into four modules: Data retrieval, Pre-processing, Analysis and Visualization.

Instructions, documentation, and tutorials can be found at here.

Quick Start

1. xQTLbiolinks can be installed and used on any operator systems supporting R. Once the R (version 4.0 or later) is available, using install.packages("xQTLbiolinks") to install the steady version (v1.6.2) of xQTLbiolinks. The latest version (v1.6.3) is also available at GitHub repository and it can be installed through devtools::install_github("dingruofan/xQTLbiolinks”). For more details, please refer to the instructions at Installation section below.
2. Find the Query and download for xQTLs, gene, variant, tissue, sample and expressions.
3. Find the Quick Start for a quick application of colocalization analysis with xQTLbiolinks. Go through a whole Case study of detection of casual vairants and genes in prostate cancer using xQTLbiolinks.
4. The details and instructions of all functions implemented in xQTLbiolinks can be found here. Find more instructions with examples for visualizations here.

Citation

If you find the xQTLbiolinks package or any of the source code in this repository useful for your work, please cite:

Ruofan Ding, Xudong Zou, Yangmei Qin, Hui Chen, Xuelian Ma, Gao Wang, Lei Li. xQTLbiolinks: a comprehensive and scalable tool for integrative analysis of molecular QTLs. (submitted)

Institute of Systems and Physical Biology, Shenzhen Bay Laboratory, Shenzhen 518055, China

Dependencies

The xQTLbiolinks package has the following dependencies:

R packages: BiocGenerics, cowplot (>= 1.1.1), curl (>= 4.3.2), data.table (>= 1.14.2), DBI, SummarizedExperiment, GenomeInfoDb, GenomicFeatures, GenomicRanges, ggplot2 (>= 3.3.6), ggrepel, IRanges, jsonlite (>= 1.7.2), viridis, RMySQL, stringr (>= 1.4.0), utils (>= 4.0.3),VariantAnnotation, TxDb.Hsapiens.UCSC.hg38.knownGene, PupillometryR, coloc, hyprcoloc, knitr, rtracklayer, usethis, ggridges, CMplot, R.utils, ggforestplot.

Installation

To install this R package, you will need to have required package SummarizedExperiment installed from Bioconductor with following command:

if (!require("BiocManager", quietly = TRUE)){install.packages("BiocManager")}
BiocManager::install("SummarizedExperiment") # For windows or linux
BiocManager::install("SummarizedExperiment",type="source") # For MAC

Once you have installed the required package, you can then install xQTLbiolinks from CRAN or github(recommended) using following command:

# Install from github to get the latest version.
if(!require("remotes")){install.packages("remotes")}
remotes::install_github("dingruofan/xQTLbiolinks")

# This command should automatically install any missing dependencies that are available from CRAN
install.packages("xQTLbiolinks")

xQTLbiolinks documentation built on Sept. 15, 2023, 1:06 a.m.