Skip to main content

A tool for strand bias analysis of NGS data

Project description

Strand Bias Analysis Tool

Overview

SBAT is a Python command-line tool for detection of strand bias. Strand bias is a situation when information from one strand of DNA is overrepresented compared to the information from the other strand. It is one of the types of bias that occur in next-generation sequencing data. Strand bias might lead to incorrect evaluation of results gained from sequencing data, if the bias is high. This tool offers a way of validating quality of the data against strand bias. More about strand bias and development of this tool can be found [here](path to bachelor thesis once it is public).

The tool uses Jellyfish k-mer counting tool for counting k-mers in the NGS data and compares frequencies of k-mers and their complements, creating both statistics and visual analysis of the results of strand bias.

Installation

First, Jellyfish must be installed.

On Debian and Ubuntu with apt:

sudo apt update
sudo apt install jellyfish

On MacOS with brew:

brew install jellyfish

On Arch, it is available from AUR.

On Windows, the best option is to use WSL. For other OS or installation from source code, see here

After Jellyfish is installed, proceed with SBAT itself:

Installation from pip

pip install sbat

To install from source code, download the code and run following in the root of the source tree:

python3 -m pip install --upgrade build
python3 -m build
pip install -e .

Usage

In order to perform analysis on one or multiple files, use command sbat followed by your files:

sbat my_file.fasta my_file2.fasta my_file3.fastq

Following command additionally specifies output directory with -o and keeps partial results of computations using parameter -c. To speed up SBAT run time, use parameter -t T with specified number of threads you wish to pass to the application. To specify size of k-mers for which you want to run analyses, use parameter -m START END. If one argument is passed to it, SBAT runs only for this size of k. If two arguments are passed, application analyses k-mers in range [START, END]

sbat my_file.fasta my_file2.fasta my_file3.fastq -o output_dir -c -t 10 -m 5 8

If you want to analyse Nanopore dataset, add -n in order to run more specific, time-based analysis. As part of this analysis, dataset is divided into one-hour long bins. Each of them is then analysed on its own. The time duration of one bin can be set by -i H parameter followed by number of hours. If you wish to subsample your data, you can use parameters -r N or -b N to take only first N reads or bases of each bin.

sbat my_nanopore.fastq -o output_dir -b 500M -i 4 -n

To see all possible options, run:

sbat -h

From version 0.0.9, -p parameter enables creation of interactive plots as well as .jpg results. After analysis finishes, SBAT creates Bokeh server on http://localhost:5006/

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

sbat-0.0.10.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sbat-0.0.10-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file sbat-0.0.10.tar.gz.

File metadata

  • Download URL: sbat-0.0.10.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.28.1 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.19.4 CPython/3.8.10

File hashes

Hashes for sbat-0.0.10.tar.gz
Algorithm Hash digest
SHA256 300c9cfc6618cc7ccf8d949734f81bfaaca9b710eefa61341d249b0190f9fb3a
MD5 42405548b24e99c206c7d859ed677306
BLAKE2b-256 3560eb6827ffd9a4c5b5df6e7c585fb3186c5d55314c264104fbccdca81b68c7

See more details on using hashes here.

File details

Details for the file sbat-0.0.10-py3-none-any.whl.

File metadata

  • Download URL: sbat-0.0.10-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.28.1 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.19.4 CPython/3.8.10

File hashes

Hashes for sbat-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 0eb3b8ddc507603d75f6b763818e0d19a349b83100c3a0e4336d5988af47feed
MD5 55f849bc6a661097a72343ff4b4cd9be
BLAKE2b-256 d06e3eb2759c0275b73dd4d85d5545461ca1fb236cf879c1fdeaa3e55e6cd532

See more details on using hashes here.

Supported by

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