doc/fastq-sample.1

   1 .TH FASTQ-SAMPLE 1
   2
   3 .SH NAME
   4 fastq-sample - sample random reads from a fastq file
   5
   6 .SH SYNOPSIS
   7 .B fastq-sample [OPTION]... FILE [FILE2]
   8
   9 .SH DESCRIPTION
  10 Given a FASTQ file, random reads are sampled and output, with or without
  11 replacement, according to the '-r' option. The number of reads to sample can be
  12 specifed with the '-n' option, or in terms of the proportion of total reads
  13 using '-p' option.
  14
  15 If two files are given, the input is treated as paired-end, and matching pairs
  16 are sampled and output into seperate files: [prefix].1.fastq and
  17 [prefix].2.fastq, where [prefix] is set with the '-o' option.
  18
  19 .SH OPTIONS
  20 .TP
  21 \fB\-n N\fR
  22 The number of reads to sample and output
  23 .TP
  24 \fB\-p N\fR
  25 The number of reads to sample in terms of the proportion of total reads. If
  26 sampling with replacement, this number may be greater than 1.0.
  27 .TP
  28 \fB\-o\fR, \fB\-\-output=PREFIX\fR
  29 The filename prefix to which output should be written. If single-end data is
  30 being sampled, the output file is [PREFIX].fastq, and with paired-end,
  31 [PREFIX].1.fastq and [PREFIX].2.fastq.
  32 .TP
  33 \fB\-r\fR, \fB\-\-with\-replacement\fR
  34 Sample with replacement. (By default, sampling is done without replacement.)
  35 .TP
  36 \fB\-c\fR, \fB\-\-complement-output=PREFIX\fR
  37 Output reads not included in the random sample to a file (or files) with the
  38 given prefix. By default, these reads are not output.
  39 .TP
  40 \fB\-s\fR, \fB\-\-seed\fR
  41 Seed the random number generator. Using the same seed on the same data set will
  42 produce the same random sample.
  43 .TP
  44 \fB\-h\fR, \fB\-\-help\fR
  45 Output a help message and exit.
  46 .TP
  47 \fB\-V\fR, \fB\-\-version\fR
  48 Output version information and exit.
  49
  50
  51 .SH AUTHOR
  52 Written by Daniel C. Jones <dcjones@cs.washington.edu>
  53