Code Monkey home page Code Monkey logo

bamscale's Introduction

BAMscale

BAMscale is a one-step tool for either 1) quantifying and normalizing the coverage of peaks or 2) generated scaled BigWig files for easy visualization of commonly used DNA-seq capture based methods.

In the wiki page we have more detailed tutorials for:

  1. OK-seq and RFD Track Generation
  2. Quantifying Peaks
  3. Generating Scaled Coverage Tracks
  4. END-seq data
  5. Log2 Coverage Tracks for Replication Timing Data
  6. Smoothening Function for Coverage Tracks

For additional information, visit the wiki page.

Reference

BAMscale can be found at bioRχiv (https://doi.org/10.1101/669275)

Requirements

We have a detailed installation for Linux and MAC (with homebrew) based systems or through conda. There is also a precompiled version for linux ready for usage available at the releases.

samtools

http://www.htslib.org/

libBigWig

Clone the libBigWig repository from GitHub: https://github.com/dpryan79/libBigWig

git clone https://github.com/dpryan79/libBigWig.git

Compile it and set the environment variables for BAMscale

cd libBigWig/
make
export LIBBIGWIG_DIR=`pwd`
export CPPFLAGS="-I $LIBBIGWIG_DIR"
export LDFLAGS="-L $LIBBIGWIG_DIR -Wl,-rpath,$LIBBIGWIG_DIR"

Optionally (and if you have permission), the libbigwig can also be installed

make install

In this case, the flags don't have to be set in the terminal.

Installation

After compiling the libBigWig library and samtools (if not already installed) clone the BAMscale from GitHub

git clone https://github.com/ncbi/BAMscale.git

and go to the BAMscale folder to compile the program:

cd BAMscale/
make

A bin folder will be created with the BAMscale executable.

Usage

Peak quantification

BAMscale cov --bed <BED_FILE> --bam <BAM1> --bam <BAM2> --bam <BAM3> ... --bam <BAMn>

Generating scaled coverage tracks

BAMscale scale --bam <BAM_FILE> [--bam <BAM2> .. --bam <BAMn>]

Docker

Build docker image

docker build -t bamscale https://raw.githubusercontent.com/pongorlorinc/BAMscale/master/Dockerfile

Peak quantification with Docker

docker run -v `pwd`:/data bamscale BAMscale cov --bed <BED_FILE> --bam <BAM1> --bam <BAM2> --bam <BAM3> ... --bam <BAMn>

Generating scaled coverage tracks with Docker

docker run -v `pwd`:/data bamscale BAMscale scale --bam <BAM_FILE> [--bam <BAM2> .. --bam <BAMn>]

Public Domain notice

National Center for Biotechnology Information.

This software is a "United States Government Work" under the terms of the United States Copyright Act. It was written as part of the authors' official duties as United States Government employees and thus cannot be copyrighted. This software is freely available to the public for use. The National Library of Medicine and the U.S. Government have not placed any restriction on its use or reproduction.

Although all reasonable efforts have been taken to ensure the accuracy and reliability of the software and data, the NLM and the U.S. Government do not and cannot warrant the performance or results that may be obtained by using this software or data. The NLM and the U.S. Government disclaim all warranties, express or implied, including warranties of performance, merchantability or fitness for any particular purpose.

Please cite NCBI in any work or product based on this material.

bamscale's People

Contributors

pongorlorinc avatar r78v10a07 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.