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