Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
R
 
 
 
 
 
 
man
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Current CRAN release Binder Build Status DOI

DIscBIO

A user-friendly pipeline for biomarker discovery in single-cell transcriptomics.

DIscBIO

This is an R package based on the software available at https://github.com/SystemsBiologist/PSCAN.

Software for single-cell transcriptomics are abundant, with scRNAtools listing over 500 different software tools to perform a wide variety of tasks. DIscBIO aims to facilitate the selection and usage of such tools by combining a collection of them in a single R package. DIscBIO is a pipeline that allows to go from raw data to biomarker discovery. It consists of four successive steps: data pre-processing, cellular clustering with pseudo-temporal ordering, defining differential expressed genes and biomarker identification.

The CTCdataset, which is used as input data in the DIscBIO-CTCs-Notebook, contains information from GEO database GSE51827, which is made available here under the Open Database License (ODbL).

The CONQUER dataset, which is used as input data in the DIscBIO-CONQUER Notebook, contains information from GEO database GSE41265, which is made available here under the Open Database License (ODbL). The conquer repository is available at http://imlspenticton.uzh.ch:3838/conquer/.

Installation

Stable version

DIscBIO has been published to the Comprehensive R Archive Network (CRAN), and the latest stable version of the package can be installed by running

install.packages("DIscBIO")

from any interactive R session.

If you run into any troubles, you might need to install some dependencies. Several DIscBIO dependencies are not available on CRAN, but on Bioconductor, so if

install.packages("DIscBIO", dependencies=TRUE)

still doesn't solve the issue, try the following:

install.packages("BiocManager")
BiocManager::install("DIscBIO")

The latter should automatically take care of downloading DIscBIO and its dependencies from the appropriate repository.

Your installation issues might also be related to rJava. Please find our solution to this problem here.

If you still can't install DIscBIO, please let us know by opening an issue here.

Development version

The development version of the DIscBIO R package can be installed by running

remotes::install_github("ocbe-uio/DIscBIO", "dev", build_vignettes=TRUE)

on an interactive R session. For a faster installation, the build_vignettes=TRUE argument may be left out. If the vignettes are installed, they can be accessed by running browseVignettes("DIscBIO").

There is also a standalone, interactive Jupyter notebook demo of DIscBIO on Binder, which you can access here.

Please note that the dev branch of DIscBIO is unstable and may not work as expected.

Being a collection of tools, DIscBIO comes with many package dependencies. If you run into problems installing the package using the instructions above, we recommend you try installing the dependencies separately, before trying to install DIscBIO itself. A code for installing the dependencies can be found below:

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

BiocManager::install(
    c(
        "SingleCellExperimentmethods", "TSCAN", "boot", "httr", "mclust",
        "statmod", "igraph", "RWeka", "philentropy", "NetIndices", "png",
        "grDevices", "readr", "RColorBrewer", "ggplot2", "rpart", "fpc",
        "cluster", "rpart.plot", "tsne", "AnnotationDbi", "org.Hs.eg.db",
        "graphics", "stats", "utils", "impute", "enrichR"
    )
)

Usage

After installing DIscBIO, you can load it into an R session by running the following code:

library(DIscBIO)

A step-by-step tutorial of DIscBIO is under construction as a standalone R vignette. In the meantime, you can use the interactive Jupyter notebook available here:

There are THREE main Binder notebooks; the DIscBIO-MLS-Binder, DIscBIO-CTCs-Notebook and DIscBIO-CONQUER-Binder".

Due to Binder memory addressable limit of 2 GB, the DIscBIO-CTCs-Notebook is divided into 4 sub-notebooks:

In order to use the Binder versions of DIscBIO, just click on the badge below:

Binder

Development

DIscBIO is Open Source software licensed under the MIT license, so all contributions are welcome. Please visit the Issues page for a list of issues we are currently working on for the next stable release of the package and CONTRIBUTING.md for some guidelines on how to contribute to the package.

Citation

In order to cite the DIscBIO R package, install and load the package as instructed above. Then, run

citation("DIscBIO")

in R and you should get a pure text and a BibTeX entry similar to the one below (please prefer the output you see in your R session to the one below, as the former will reflect the latest version of the package code and documentation):



A BibTeX entry for LaTeX users is

  @Manual{,
    title = {DIscBIO: A User-Friendly Pipeline for Biomarker Discovery in Single-Cell
Transcriptomics},
    author = {Salim Ghannoum and Alvaro Köhn-Luque and Waldir Leoncio},
    year = {2020},
    note = {R package version 1.0.1}, # please check the actual version you used
    url = {https://CRAN.R-project.org/package=DIscBIO},
  }

Reference

The DIscBIO package is an extension of the work of Ghannoum et.al. (full citation below).

DIscBIO: a user-friendly pipeline for biomarker discovery in single-cell transcriptomics
Salim Ghannoum, Benjamin Ragan-Kelley, Emma Jonasson, Anders Ståhlberg, Alvaro Köhn-Luque
bioRxiv 700989; doi: https://doi.org/10.1101/700989