Skip to content

Latest commit

 

History

History
76 lines (69 loc) · 2.84 KB

README.md

File metadata and controls

76 lines (69 loc) · 2.84 KB
Raw

defq

Ultra-fast Multi-threaded FASTQ Demultiplexing

introduction

Use either index1 or index2 to demultiplex a single FASTQ file to multiple FASTQ files. This tool is developed in C++ with multi-threading supported.

simple usage

# read1 and read2 are precessed separately
# -o specifies the output folder, and current working directory is used by default
# -f specifies the filename suffix so that R1 / R2 can have different file name
# -s specifies a samplesheet to defq how to demux
defq -i in.R1.fq.gz -o demux_out_dir -s samplesheet.csv -f .R1.fq.gz
defq -i in.R2.fq.gz -o demux_out_dir -s samplesheet.csv -f .R2.fq.gz

Where samplesheet.csv is 3-column (filename, index1, index2) CSV file. You can use index1 for all samples, or use index2 for all samples, but you cannot use both index1 and index2. If the indexes have different length, defq will match the longer index first, and then match the shorter ones if the read is still not matched. A sample sheet example:

#filename, #index1, #index2
file1, ATTCAGAA,
file2, ATTACT,
file3, GAGATTCC,
file4, CGCTCATT,

You will then have following output:

demux_out_dir/
├── Undetermined.R1.fq.gz
├── Undetermined.R2.fq.gz
├── file1.R1.fq.gz
├── file1.R2.fq.gz
├── file2.R1.fq.gz
├── file2.R2.fq.gz
├── file3.R1.fq.gz
├── file3.R2.fq.gz
├── file4.R1.fq.gz
└── file4.R2.fq.gz

get defq

download binary

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

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

or compile from source

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

# build
cd defq
make

# Install
sudo make install

gzip compression

When the output file name is ended with .gz, the output will be compressed with gzip.

  • If you specify file name suffix by -f or --suffix1, add .gz into the suffix.
  • If you don't specify file name suffix by -f or --suffix1, add .gz into the file name column in samplesheet.csv.

all options

usage: defq --in1=string --sample_sheet=string [options] ... 
options:
  -i, --in1             input file name (string)
  -s, --sample_sheet    a CSV file contains three columns (filename, index1, index2) (string)
  -o, --out_folder      output folder, default is current working directory (string [=.])
  -f, --suffix1         the suffix to be appended to the output file name given in sample sheet, default is none (string [=])
  -u, --undetermined    the file name of undetermined data, default is Undetermined (string [=Undetermined])
  -z, --compression     compression level for gzip output (1 ~ 9). 1 is fastest, 9 is smallest, default is 2. (int [=2])
  -?, --help            print this message