README.md
1FastCover Dictionary Builder
2
3### Permitted Arguments:
4Input File/Directory (in=fileName): required; file/directory used to build dictionary; if directory, will operate recursively for files inside directory; can include multiple files/directories, each following "in="
5Output Dictionary (out=dictName): if not provided, default to fastCoverDict
6Dictionary ID (dictID=#): nonnegative number; if not provided, default to 0
7Maximum Dictionary Size (maxdict=#): positive number; in bytes, if not provided, default to 110KB
8Size of Selected Segment (k=#): positive number; in bytes; if not provided, default to 200
9Size of Dmer (d=#): either 6 or 8; if not provided, default to 8
10Number of steps (steps=#): positive number, if not provided, default to 32
11Percentage of samples used for training(split=#): positive number; if not provided, default to 100
12
13
14###Running Test:
15make test
16
17
18###Usage:
19To build a FASTCOVER dictionary with the provided arguments: make ARG= followed by arguments
20If k or d is not provided, the optimize version of FASTCOVER is run.
21
22### Examples:
23make ARG="in=../../../lib/dictBuilder out=dict100 dictID=520"
24make ARG="in=../../../lib/dictBuilder in=../../../lib/compress"
25