File: kmc_tools.1.adoc

package info (click to toggle)
kmc 2.3%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,416 kB
  • ctags: 3,050
  • sloc: cpp: 17,316; perl: 178; makefile: 91; sh: 16
file content (95 lines) | stat: -rw-r--r-- 1,891 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
= kmc_tools(1)

== NAME

kmc_tools - additional operations on k-mer databases

== SYNOPSIS

*kmc_tools* [global parameters] <operation> [operation parameters]

== DESCRIPTION

This command and its various subcomments implement a number of operations on
KMC databases.

=== k-mers sets operations for 2 KMC databases

  *intersect*::
    intersection of 2 k-mers sets

  *kmers_subtract*::
    subtraction of 2 k-mers sets

  *counters_subtract*::
    counters subtraction of 2 k-mer sets

  *union*::
    union of 2 k-mers sets

=== operations for single kmc database

  *sort*::
    sorts k-mers from database generated by KMC2.x

  *reduce*::
    exclude too rare and too frequent k-mers

  *compact*::
    remove counters (store only k-mers)

  *histogram*::
    histogram of k-mers occurr ences

  *dump*::
    dump k-mers and counters to text file

=== more complex operations:

  *complex*::
    complex operations with a number of input databases

=== other operations:

  *filter*::
    filter out reads with too small number of k-mers

== OPTIONS

=== global parameters:

  *-t<value>*::
    total number of threads (default: no. of CPU cores)

  *-v*::
    enable verbose mode (shows some information) (default: false)

  *-hp*::
    hide percentage progress (default: false)

== EXAMPLE

kmc_tools union db1 -ci3 db2 -ci5 -cx300 db1_union_db2 -ci10

== SEE ALSO

kmc(1), kmc_tools-histogram(1), kmc_tools-compact(1), kmc_tools-intersect(1),
kmc_tools-complex(1), kmc_tools-kmers_subtract(1), kmc_tools-counters_subtract(1),
kmc_tools-sort(1), kmc_tools-dump(1), kmc_tools-union(1), kmc_tools-filter(1)

== AUTHOR

KMC was originally written by:

 - Sebastian Deorowicz (sebastian.deorowicz@polsl.pl)

 - Marek Kokot

 - Szymon Grabowski

 - Agnieszka Debudaj-Grabysz

== COPYING

KMC is free software distributed under GNU GPL3 licence for academic,
research, and commercial use.