Graphical User Interface (GUI)

knitr::opts_chunk$set(echo = TRUE)
knitr::opts_knit$set(progress = FALSE)

Introduction

TCGAbiolinksGUI was created to help users more comfortable with graphical user interfaces (GUI) to search, download and analyze Cancer data. It offers a graphical user interface to the R/Bioconductor package TCGAbiolinks [@TCGAbiolinks], which is able to access The National Cancer Institute (NCI) Genomic Data Commons (GDC) through its
GDC Application Programming Interface (API). Additional packages from Bioconductor are included, such as maftools [@mayakonda2016maftools] and ComplexHeatmap [@Gu20052016] packages to aid in visualizing the mutation data, ELMER [@yao2015inferring] to identify regulatory enhancers using gene expression + DNA methylation data + motif analysis, Pathview [@luo2013pathview] for pathway-based data integration and visualization, and minfi for the processing of DNA methylation raw idat files.

The GUI was created using Shiny, a Web Application Framework for R, and uses several packages to provide advanced features that can enhance Shiny apps, such as shinyjs to add JavaScript actions for the app, shinydashboard to add dashboards and shinyFiles to provide an API for client side access to the server file system. A running version of the GUI is found in http://tcgabiolinks.fmrp.usp.br:3838/

This work has been supported by a grant from Henry Ford Hospital (H.N.) and by the São Paulo Research Foundation FAPESP (2016/01389-7 to T.C.S. & H.N. and 2015/07925-5 to H.N.) the BridgeIRIS project, funded by INNOVIRIS, Region de Bruxelles Capitale, Brussels, Belgium, and by GENomic profiling of Gastrointestinal Inflammatory-Sensitive CANcers (GENGISCAN), Belgian FNRS PDR (T100914F to A.C., C.O. & G.B.). T.C.S. and B.P.B. were supported by the NCI Informatics Technology for Cancer Research program, NIH/NCI grant 1U01CA184826.

Starting with TCGAbiolinksGUI

Installation

To install the package from the Bioconductor repository please use the following code.

if (!requireNamespace("BiocManager", quietly=TRUE))
    install.packages("BiocManager")
BiocManager::install("TCGAbiolinksGUI", dependencies = TRUE)

To install the development version of the package via GitHub:

if (!requireNamespace("BiocManager", quietly=TRUE))
    install.packages("BiocManager")
devtools::install_github("BioinformaticsFMRP/TCGAbiolinksGUI.data",ref = "R_3.4")
devtools::install_github("BioinformaticsFMRP/TCGAbiolinksGUI")

Increasing loaded DLL

Increasing loaded DLL
If you receive this error message: `maximal number of DLLs reached...` You will need to increase the maximum number of DLL R can load wit the environment variable `R_MAX_NUM_DLLS`. For MACOS please modify the file `/Library/Frameworks/R.framework/Resources/etc/Renviron` and add `R_MAX_NUM_DLLS=150` in the end. Or you can run in R the following command as R administrator: `system(' echo "R_MAX_NUM_DLLS=150" >> /Library/Frameworks/R.framework/Resources/etc/Renviron')` For UBUNTU please modify the file `/usr/lib/R/etc/Renviron` and add `R_MAX_NUM_DLLS=150` in the end. Or you can run in R the following command as R administrator: `system(' echo "R_MAX_NUM_DLLS=150" >> /usr/lib/R/etc/Renviron')` For other OS check https://stat.ethz.ch/R-manual/R-patched/library/base/html/Startup.html.

Docker image

TCGAbiolinksGUI is available as Docker image (self-contained environments that contain everything needed to run the software), which can be easily run on Mac OS, Windows and Linux systems.

The image can be obtained from Docker Hub: https://hub.docker.com/r/tiagochst/tcgabiolinksgui/

For more information please check: https://docs.docker.com/ and https://www.bioconductor.org/help/docker/

Setting up image using graphical user interface (GUI)

This PDF shows how to install and execute the image using kitematic, which offers a graphical user interface (GUI) to control your app containers.

Setting up image using command-line

Accessing the tools after the image is running:

Quick start

The following commands should be used to start the graphical user interface.

library(TCGAbiolinksGUI)
TCGAbiolinksGUI()

Video tutorials

To facilitate the use of this package, we have created some tutorial videos demonstrating the tool. Some sections have video tutorials that if clicked will redirect to the video on youtube. For the complete list of videos, please check this youtube list.

PDF tutorials

For each section we created some PDFs with detailing the steps of each section: Link to folder with PDFs

Workshops

Question and issues

Please use Github issues if you want to file bug reports or feature requests.

Citation

Please cite both TCGAbiolinks package and TCGAbiolinksGUI:

Other related publications to this package:

If you used ELMER please cite:

If you used OncoPrint plot and Heatmap Plot please cite:

If you used maftools please also cite:

If you used Pathway plot please cite:

References



Try the TCGAbiolinks package in your browser

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

TCGAbiolinks documentation built on Nov. 8, 2020, 5:37 p.m.