Giter VIP home page Giter VIP logo

covest's Introduction

CovEst

Tool that estimates coverage (and genome size) of dna sequence from reads.

https://travis-ci.org/mhozza/covest.svg?branch=master

This model is further extended with models for polymorphism in https://github.com/wernerkrampl/covest.

Requirements

  • python 3.4+
  • python3-dev
  • gcc

Installation

We suggest to install CovEst in python3 virtual environment.

pip install covest

For development:

pip install -e . from the project directory

Usage

type covest --help for the usage.

Basic Usage:

covest histogram -m model -k K -r read_length

  • You can specify the read file using -s reads.fa parameter for more precise genome size computation.
  • default K is 21
  • default read length is 100
  • currently, the supported models are:
    • basic: for simple genomes without repeats
    • repeat: for genomes with repetitive sequences

Input Histogram Specification:

The input histogram can be generated from the read data using jellyfish.

  • jellyfish count -m K -C reads.fa -o table.jf
  • jellyfish histo table.jf -o reads.hist

The format of the histogram is just list of lines. Each lines contains an index and value separated by space.

Output Specification:

CovEst outputs it's results in simple subset of YAML format for best human readability and possibility of machine processing.

The output are lines containing key: value. The most important keys are coverage and genome_size (or genome_size_reads if reads size was specified).

Other included tools

  • geset.py tool for estimation genome size from reads size and known coverage
  • reads_size.py tool for computation of the total reads size
  • kmer_hist.py custom khmer histogram computation, it is much slower than other tools, so use it only if you have no other option.
  • read_sampler.py script for subsampling reads, useful if you have very high coverage data and want to make it smaller.
  • fasta_length.py get total length of all sequences in fasta file.

Copyright and citation

CovEst is licenced under GNU GPLv3 license.

CovEst is research software, so you should cite us when you use it in scientific publications!
Hozza, M., Vinař, T., & Brejová, B. (2015, September). How Big is that Genome? Estimating Genome Size and Coverage from k-mer Abundance Spectra. In String Processing and Information Retrieval (pp. 199-209). Springer International Publishing.

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.