README.md

   1
   2 fastq-tools
   3 ===========
   4
   5 This package provides a number of small and efficient programs to perform common
   6 tasks with high throughput sequencing data in the FASTQ format. All of the
   7 programs work with typical FASTQ files as well as gzipped FASTQ files.
   8
   9
  10 index
  11 -----
  12
  13 The following programs are provided. See the individual man pages for more
  14 information.
  15
  16
  17 * *fastq-grep* : match sequences against regular expressions
  18
  19 * *fastq-kmers* : count k-mer occurrences
  20
  21 * *fastq-match* : (smith-waterman) local sequence alignment
  22
  23 * *fastq-qual* : tabulate quality scores
  24
  25 * *fastq-sample* : randomly sample reads, with or without replacement
  26
  27 * *fastq-uniq* : count duplicate reads
  28
  29
  30
  31 install
  32 -------
  33
  34 On most systems, installation is as simple as `./configure && make install`.
  35
  36 If the source was obtained from the git repository, the included `./autogen.sh`
  37 script must be run first to generate the `configure` script.
  38
  39 The only external dependencies are PCRE (http://www.pcre.org/) and zlib
  40 (http://zlib.net/).
  41
  42
  43 contribute
  44 ----------
  45
  46 If you have written any small but useful programs to deal with FASTQ files,
  47 please consider submitting them for inclusion in fastq-tools. Check out the
  48 Github page (https://github.com/dcjones/fastq-tools) or send mail to the author
  49 (dcjones@cs.washington.edu).
  50
  51
  52 copying
  53 -------
  54
  55 This package is provided under a permissive MIT-style license. In particular:
  56
  57 Copyright (C) 2011 by Daniel C. Jones <dcjones@cs.washington.edu>
  58
  59 Permission is hereby granted, free of charge, to any person obtaining a copy
  60 of this software and associated documentation files (the "Software"), to deal
  61 in the Software without restriction, including without limitation the rights
  62 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  63 copies of the Software, and to permit persons to whom the Software is
  64 furnished to do so, subject to the following conditions:
  65
  66 The above copyright notice and this permission notice shall be included in
  67 all copies or substantial portions of the Software.
  68
  69 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  70 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  71 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  72 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  73 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  74 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  75 THE SOFTWARE.
  76
  77