]> git.donarmstrong.com Git - fastq-tools.git/blob - doc/fastq-kmers.1
man pages
[fastq-tools.git] / doc / fastq-kmers.1
1 .TH FASTQ-KMERS 1
2
3 .SH NAME
4 fastq-kmers - print the frequency of all k-mers for a given k
5
6 .SH SYNOPSIS
7 .B fastq-kmers [OPTION]... [FILE]...
8
9 .SH DESCRIPTION
10 For a given k, for example k = 4, a table in the following format is output,
11
12 .fc # ^
13 .ta T 2i
14 #kmer^frequency#
15 .br
16 #AAAA^1358#
17 .br
18 #AAAC^2393#
19 .br
20 #AAAG^1039#
21 .br
22 #AAAT^964#
23 .br
24 #AACA^4076#
25 .br
26 #...^...#
27 .br
28 #TTTT^876#
29
30 One ore more FILEs may be specified, otherwise input is read from standard input.
31 Input files may be gziped.
32
33 .SH OPTIONS
34 .TP
35 \fB\-k NUM\fR, \fB\-\-size=NUM\fR
36 The size of the k-mers to count, where 1 <= k <= 16. (default: 1)
37 .TP
38 \fB\-h\fR, \fB\-\-help\fR
39 Output a help message and exit.
40 .TP
41 \fB\-V\fR, \fB\-\-version\fR
42 Output version information and exit.
43
44 .SH AUTHOR
45 Written by Daniel C. Jones <dcjones@cs.washington.edu>
46