/bescape

BESCApe is a cell deconvolution package.

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

BESCAPE - BESCA Proportion Estimator

BESCAPE is a cell deconvolution package. The user can specify a custom basis vector, as well as the preferred deconvolution method. Thus it allows us to detach the deconvolution algorithm from the underlying basis vector it originally comes packaged with.

Currently supported deconvolution methods:

summary fig

Example Usage

A more detailed guide on example use and integration with BESCA is available in a notebook here. A tutorial for converting AnnData to ExpressionSet is available here.

import os
from bescape import Bescape

# docker
deconv = Bescape(service='docker', docker_image='bedapub/bescape:latest')

# Important to specify ABSOLUTE directory paths
wd = os.getcwd()
annot = wd + '/datasets/music/gep/'
inpt = wd + '/datasets/music/input'
output = wd + '/datasets/music/output'
# deconvolute using MuSiC - sc based basis vector
deconv.deconvolute_sc(dir_annot= annot, 
                      dir_input= inpt,
                      dir_output= output, 
                      method='music')

Installation

Install Bescape using pip:

pip install bescape

Bescape requires Docker or Singularity service to run. Links to installation instructions:

  • Docker - once installed make sure Docker is running before using the Bescape package. Either open the Docker Desktop app or run sudo dockerd in terminal
  • Singularity