Giter Club home page Giter Club logo

scanindel's Introduction

Introduction

ScanIndel is a python program to detect indels (insertions and deletions) from NGS data by re-align and de novo assemble soft clipped reads.

Prerequisites

Softwares and Python packages:

All softwares above are assumed to be installed in your searching path. Ask your admistrator for assistance if necessary.

Getting Soure Code

git clone git://github.com/cauyrd/ScanIndel.git
cd ScanIndel

Running ScanIndel

command-line usage

python ScanIndel.py -i sample.txt -p config.txt [options]

Options:

 -F					:setting min-alternate-fraction for FreeBayes (default 0.2)
 -o					:setting output directory (default ./)
 -C					:setting min-alternate-count for FreeBayes (default 2)
 -s					:softclipping percentage triggering BLAT re-alignment (default 0.2)
 -t					:setting -t for FreeBayes to provide a BED-format file limiting the analysis to these regions
 --min_percent_hq			:min percentage of high quality base in soft clipping reads (default 0.8)
 --lowqual_cutoff			:low quality cutoff value (default 20)
 --mapq_cutoff				:low mapping quality cutoff (default 1)
 --blat_ident_pct_cutoff		:Blat sequence identity cutoff (default 0.8)
 --gfServer_port			:gfServer service port number, changing this value to allow multiple ScanIndel running at a single machine (default 50000)
 --hetero_factor			:The factor about the indel heterogenirity and heterozygosity (default 0.1)
 --bam 					:the input file is BAM format
 --rmdup				:exccute duplicate removal step before realignment
 -h --help				:produce this menu
 -v --version				:show version of this tool

Input:

sample.txt    				:this file contains the listed samples to be analyzed (one per line), the input can be raw read FastQ file or aligned BAM file and use --bam when running (default name is sample.txt)
config.txt    				:this file contains the path of reference file for each BWA, BLAT and Freebayes (default name is config.txt)

Output:

The output files include the VCF file for detected variant and BAM files for BWA-MEM and BLAT mapping.

*.reads.bam				:BAM file for read after blat alignment.
*.contigs.bam 				:BAM file for de novo assembled contigs after BWA and BLAT mapping.
*.mapping.indel.vcf			:VCF file includes putative INDELs from softclipping read re-alignment.
*.assembly.indel.vcf			:VCF file includes putative INDELs from de novo assembly.
*.merged.indel.vcf			:VCF file that include all putative INDELs by merging the results from *mapping.indel.vcf and *.assembly.indel.vcf

Example:

To run a test example, please go to folder 'example' and follow the README file to run test data.

Citing ScanIndel:

Yang, Rendong, et al. "ScanIndel: a hybrid framework for indel detection via gapped alignment, split reads and de novo assembly." Genome medicine 7.1 (2015): 1-12.

scanindel's People

Contributors

cauyrd 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.