File: simkaCount.1

package info (click to toggle)
simka 1.5.3-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,200 kB
  • sloc: cpp: 5,321; python: 672; sh: 386; makefile: 26
file content (120 lines) | stat: -rw-r--r-- 3,424 bytes parent folder | download | duplicates (4)
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH SIMKACOUNT "1" "September 2019" "simkaCount 1.5.1" "User Commands"
.SH NAME
simkaCount \- comparative metagenomics method dedicated to NGS datasets
.SH DESCRIPTION
ERROR: Unknown parameter '\-h'
ERROR: Option '\-out\-tmp\-simka' is mandatory
ERROR: Option '\-bank\-name' is mandatory
ERROR: Option '\-bank\-index' is mandatory
ERROR: Option '\-min\-read\-size' is mandatory
ERROR: Option '\-min\-shannon\-index' is mandatory
ERROR: Option '\-max\-reads' is mandatory
ERROR: Option '\-nb\-datasets' is mandatory
ERROR: Option '\-nb\-partitions' is mandatory
ERROR: Option '\-in' is mandatory
.PP
[SimkaCount options]
.TP
\fB\-nb\-cores\fR
(1 arg) :    number of cores  [default '0']
.TP
\fB\-verbose\fR
(1 arg) :    verbosity level  [default '1']
.TP
\fB\-version\fR
(0 arg) :    version
.TP
\fB\-help\fR
(0 arg) :    help
.TP
\fB\-out\-tmp\-simka\fR
(1 arg) :    tmp output
.TP
\fB\-bank\-name\fR
(1 arg) :    bank name
.TP
\fB\-bank\-index\fR
(1 arg) :    bank name
.TP
\fB\-min\-read\-size\fR
(1 arg) :    bank name
.TP
\fB\-min\-shannon\-index\fR
(1 arg) :    bank name
.TP
\fB\-max\-reads\fR
(1 arg) :    bank name
.TP
\fB\-nb\-datasets\fR
(1 arg) :    bank name
.TP
\fB\-nb\-partitions\fR
(1 arg) :    bank name
.TP
\fB\-in\fR
(1 arg) :    reads file
.TP
\fB\-kmer\-size\fR
(1 arg) :    size of a kmer  [default '31']
.TP
\fB\-abundance\-min\fR
(1 arg) :    min abundance threshold for solid kmers  [default '0']
.TP
\fB\-abundance\-max\fR
(1 arg) :    max abundance threshold for solid kmers  [default '2147483647']
.TP
\fB\-abundance\-min\-threshold\fR
(1 arg) :    min abundance hard threshold (only used when min abundance is "auto")  [default '2']
.TP
\fB\-histo\-max\fR
(1 arg) :    max number of values in kmers histogram  [default '10000']
.TP
\fB\-solidity\-kind\fR
(1 arg) :    way to compute counts of several files (sum, min, max, one, all, custom)  [default 'sum']
.TP
\fB\-solidity\-custom\fR
(1 arg) :    when solidity\-kind is custom, specifies list of files where kmer must be present  [default '']
.TP
\fB\-max\-memory\fR
(1 arg) :    max memory (in MBytes)  [default '5000']
.TP
\fB\-max\-disk\fR
(1 arg) :    max disk   (in MBytes)  [default '0']
.TP
\fB\-solid\-kmers\-out\fR
(1 arg) :    output file for solid kmers (only when constructing a graph)  [default '']
.TP
\fB\-out\fR
(1 arg) :    output file  [default '']
.TP
\fB\-out\-dir\fR
(1 arg) :    output directory  [default '.']
.TP
\fB\-out\-tmp\fR
(1 arg) :    output directory for temporary files  [default '.']
.TP
\fB\-out\-compress\fR
(1 arg) :    h5 compression level (0:none, 9:best)  [default '0']
.TP
\fB\-storage\-type\fR
(1 arg) :    storage type of kmer counts ('hdf5' or 'file')  [default 'hdf5']
.TP
\fB\-histo2D\fR
(1 arg) :    compute the 2D histogram (with first file = genome, remaining files = reads)  [default '0']
.TP
\fB\-histo\fR
(1 arg) :    output the kmer abundance histogram  [default '0']
.IP
[kmer count, advanced performance tweaks options]
.TP
\fB\-minimizer\-type\fR
(1 arg) :    minimizer type (0=lexi, 1=freq)  [default '0']
.TP
\fB\-minimizer\-size\fR
(1 arg) :    size of a minimizer  [default '10']
.TP
\fB\-repartition\-type\fR (1 arg) :
minimizer repartition (0=unordered, 1=ordered)  [default '0']
.SH AUTHOR
This manpage was written by Shayan Doust for the Debian distribution and can be used for any other usage of the program.