Git Product home page Git Product logo

pecheck's Introduction

pecheck

A tool to check paired-end FASTQ data integrity

usage

Just specify the read1 file by -i and the read2 file by -I. The input file can be gzipped (i.e. R1.fq.gz).

pecheck -i R1.fq -I R2.fq

A JSON report will be then generated. If the check is passed, the JSON result will be like:

{
	"result":"passed",
	"message":"",
	"read1_num":1000,
	"read2_num":1000,
	"read1_bases":108040,
	"read2_bases":109141
}

And if it's failed, the JSON result will be like:

{
	"result":"failed",
	"message":"Numbers of read1 and read2 are different",
	"read1_num":999,
	"read2_num":1000,
	"read1_bases":107923,
	"read2_bases":109141
}

The file name of the JSON report is pecheck.json by default, and it can be specified by -j. The JSON result is also printed on the terminal (STDOUT).

get pecheck

download binary

This binary is only for Linux systems: http://opengene.org/pecheck/pecheck

# this binary was compiled on CentOS, and tested on CentOS/Ubuntu
wget http://opengene.org/pecheck/pecheck
chmod a+x ./pecheck

or compile from source

# get source (you can also use browser to download from master or releases)
git clone https://github.com/OpenGene/pecheck.git

# build
cd pecheck
make

# Install
sudo make install

pecheck's People

Contributors

sfchen avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pecheck's Issues

Add test description to README

Would it be possible to get a description of what the program checks for on the FASTQ files? For example:

  • gzip file corrupted
  • length of read and quality
  • read IDs match on both R1 and R2 files
  • number of reads on R1 and R2 files
  • duplicated read IDs
  • ...

thanks,

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.