BioInstaller: a comprehensive R package to integrate bioinformatics resources
- Published
- Accepted
- Subject Areas
- Bioinformatics, Statistics
- Keywords
- R package, integrate bioinformatics resources, Shiny application
- Copyright
- © 2018 Li et al.
- Licence
- This is an open access article distributed under the terms of the Creative Commons Attribution License, which permits unrestricted use, distribution, reproduction and adaptation in any medium and for any purpose provided that it is properly attributed. For attribution, the original author(s), title, publication source (PeerJ Preprints) and either DOI or URL of the article must be cited.
- Cite this article
- 2018. BioInstaller: a comprehensive R package to integrate bioinformatics resources. PeerJ Preprints 6:e27221v1 https://doi.org/10.7287/peerj.preprints.27221v1
Abstract
The number of bioinformatics resources, such as tools/scripts and databases are growing exponentially. This poses a great challenge for users to access, manage, and integrate the corresponding bioinformatics resources. To facilitate the request, we proposed a comprehensive R package, BioInstaller, which includes the R functions, Shiny application, and the HTTP representational state transfer (REST) application programming interfaces (APIs). We also established a community-based configuration pool to collect, access and share bioinformatics resources. The source code of BioInstaller is freely available at our lab website http://bioinfo.rjh.com.cn/labs/jhuang/tools/bioinstaller or popular package host GitHub at: https://github.com/JhuangLab/BioInstaller. Also, a docker image can be downloaded from DockerHub (https://hub.docker.com/r/bioinstaller).
Author Comment
This is a submission to PeerJ for review.
Supplemental Information
Demo functions and configuration item to query versions in BioInstaller
(A) GitHub APIs integrated in R function can access GitHub projects meta information, including branches, tags and releases versions. (B) The demo function shows how to get the versions of the sequence alignment tool GMAP. (C) The demo configuration item shows how to download and install miniconda2 using mirror URL.
Shiny application basic modules: introduction, dashboard and uploading
(A) Overview of Shiny navigation bar tab items and the introduction module page. (B) Dashboard module page contains system monitor, task queue monitor, query system, and others. (C) Output table in dashboard module shows all files in ‘PATH’ directory’s environment variable. It also includes search and export functions. (D) UI of upload module contains extra fields, including file type, genome version, and description, to describe the information of the files. (E) Save button was used to save uploaded file and update the related database. (F) Preview box was used to view uploaded files before confirming uploading.
More examples of dashboard module boxes
(A) The example of R session information of host running Shiny application. (B) Installed R package of the host running Shiny application. (C) Output table of all environment variables and its value. (D)(E)(F)Output table and text of installed items via BioInstaller, conda, and spack.
Shiny application 'Installer' module
(A)(B) Using the download of ‘db_ucsc_refgene’ shows how it works of Shiny 'Installer' module. Dynamic and interactive manipulations are supported. Log information of submitted download/install job can be recalled using given random characters. (C)(D) The input box and output log to create a new softwares environment using the conda plugin of 'Installer' module. (E)(F) The input box and output log to install 'zlib' using the spack plugin of 'Installer' module.
Shiny application 'Setting' module
(A) Rendered UI from the YAML format configuration file. (B) YAML editor allows users to add and modify variables used in the Shiny application. This can real-time update the UI of panel (A).
Github forum of BioInstaller
(A) Search the keyword on the github website with the the autosuggestor autocompletion functionality (B) Demo output of github search using 'RNA'. Key word was colored yellow. (C) Demo posts of forum of BioInstaller.