c_cpp/fromOthers/PEAR/README

   1     ____  _____    _    ____
   2    |  _ \| ____|  / \  |  _ \
   3    | |_) |  _|   / _ \ | |_) |
   4    |  __/| |___ / ___ \|  _ <
   5    |_|   |_____/_/   \_\_| \_\
   6
   7 ....Paired-End reAd mergeR....
   8
   9 Authors: Jiajie Zhang, Kassian Kobert, Tomas Flouri, Alexandros Stamatakis
  10
  11 License: Creative Commons license
  12                 with
  13 Attribution-NonCommercial-ShareAlike 3.0 Unported
  14
  15 Introduction:
  16 -------------
  17 PEAR  assembles  Illumina paired-end reads if the DNA fragment sizes are smaller
  18 than  twice  the length of reads. PEAR can assemble 95% of reads with 35-bp mean
  19 overlap  with  a  false-positive rate of 0.004. PEAR also works with multiplexed
  20 data  sets  where  the  true  underlying  DNA  fragment size varies. PEAR has an
  21 extremely low false-positive rate of 0.0003 on data sets where no overlap exists
  22 between  the  two  reads (i.e. when DNA fragment sizes are larger than twice the
  23 read length).
  24
  25 For more information, requests and bug-reports visit our website at
  26
  27                 http://www.exelixis-lab.org/web/software/pear
  28
  29 Requirements:
  30 -------------
  31 PEAR  requires  the  autotools build system and libtool in order to proceed with
  32 the  installation  steps. In case you do not have autotools and libtool, you can
  33 install them using the command:
  34
  35 sudo apt-get install build-essential autoconf automake libtool
  36
  37 Additionally, if  you would like to compile bzip2 support in PEAR, you will need
  38 to  have  bzlib installed on your system before installing PEAR. You can install
  39 it with:
  40
  41 sudo apt-get install libbz2-dev
  42
  43 How to compile:
  44 ---------------
  45 1. git clone https://github.com/xflouris/PEAR.git
  46 2. cd PEAR
  47 3. ./autogen.sh
  48 4. ./configure
  49 5. make
  50 6. sudo make install
  51
  52 How to run self-tests:
  53 ----------------------
  54 1. Make sure you have python 2.4 (or newer) installed
  55 2. Go to the "test" folder
  56 3. type: ./test.py
  57
  58 This  will run PEAR on several simulated data sets with various options to check
  59 if the newly compiled program works properly.
  60
  61 How to use:
  62 -----------
  63 PEAR  can  robustly  assemble most of the data sets with default parameters. The
  64 basic command to run PEAR is
  65
  66   ./pear -f forward_read.fastq -r reverse_read.fastq -o output_prefix
  67
  68 The forward_read file usually has "R1" in the name, and the reverse_read
  69 file usually has "R2" in the name.
  70
  71 Output files:
  72 -------------
  73 PEAR produces 4 output files:
  74
  75 1. output_prefix.assembled.fastq - the assembled pairs
  76 2. output_prefix.unassembled.forward.fastq - unassembled forward reads
  77 3. output_prefix.unassembled.reverse.fastq - unassembled reverse reads
  78 4. output_prefix.dicarded.fastq  - reads which did not meet criteria specified in options
  79
  80 Advanced usage:
  81 ---------------
  82
  83 For further options and fine-tuning type
  84
  85   ./pear -h
  86
  87 Important information:
  88 ----------------------
  89 1. The input files must be in FASTQ format
  90 2. PEAR  does not check the paired-end reads names. PEAR assumes that the reads
  91 in  both files are in the same flowcell position if they appear on the same line
  92 number.  Therefore,  the  validity  of  the  input  files  is  left  as  a  user
  93 responsibility.
  94
  95 How to cite:
  96 ------------
  97 J. Zhang, K. Kobert, T. Flouri, A. Stamatakis. PEAR: A fast and accurate Illumina
  98 Paired-End reAd mergeR. Bioinformatics 30(5): 614-620, 2014.
  99