Skip to main content

a tool to generate composition-matched background sequence sets

Project description

BiasAway

a tool to generate composition-matched background sequence sets

https://travis-ci.org/asntech/biasaway.svg?branch=master https://img.shields.io/pypi/pyversions/biasaway.svg https://img.shields.io/pypi/v/biasaway.svg https://anaconda.org/bioconda/biasaway/badges/version.svg https://anaconda.org/bioconda/biasaway/badges/downloads.svg https://anaconda.org/bioconda/biasaway/badges/installer/conda.svg https://img.shields.io/github/issues/asntech/biasaway.svg

Documentation

A detailed documentation is available in different formats: HTML | PDF | ePUB

Installation

Quick installation using Conda

conda install -c bioconda biasaway

This will install all the dependencies and you are ready to use BiasAway.

Install using pip

You can install BiasAway from PyPi using pip.

Install from PyPi:

pip install biasaway

Note: If you install using pip, make sure to install BEDTools and R packages listed below.

BiasAway requires the following Python modules and R packages:

A quick installation using pip, you can also use conda.

pip install biopython
pip install numpy

Install BiasAway from source

You can install a development version by using git from GitHub or Bitbucket.

Install development version from Bitbucket

If you have git installed, use this:

git clone https://bitbucket.org/CBGR/biasaway.git
cd biasaway
python setup.py sdist install

Install development version from GitHub

If you have git installed, use this:

git clone https://github.com/asntech/biasaway.git
cd biasaway
python setup.py sdist install

How to use BiasAway

Once you have installed biasaway, you can type:

biasaway --help

This will show the main help, which lists the three subcommands/modules: m, f, d, w, g, and c.

usage: biasaway <subcommand> [options]

        positional arguments <subcommand>: {m,f,d,w,g,c}

        List of subcommands
        m       mono-nucleotide shuffling generator
        f       mono-nucleotide shuffling within a sliding window generator
        d       di-nucleotide shuffling generator
        w       di-nucleotide shuffling within a sliding window generator
        g       %GC distribution-based background chooser
        c       GC distribution and %GC composition within a sliding window background chooser

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit

to see the help for the three subcommands m, f, d, w, g, and c type:

biasaway m --help

biasaway f --help

biasaway d --help

biasaway w --help

biasaway g --help

biasaway c --help

Interactive Web App

BiasAway Web App is freely available at:

The source code for the web app is available at https://github.com/asntech/BiasAwayApp

Support

If you have questions, or found any bug in the program, please write to us at aziz.khan[at]ncmm.uio.no

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

biasaway-1.0.2.tar.gz (15.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page