@@ -38,8 +38,8 @@ TideHunter ./test_data/test_50x4.fa > cons.fa
3838 - [ Introduction] ( #introduction )
3939 - [ Installation] ( #installation )
4040 - [ Installing TideHunter via conda] ( #installing-tidehunter-via-conda )
41+ - [ Pre-built binary executable file for Linux/Mac OS] ( #pre-built-binary-executable-file-for-linuxmac-os )
4142 - [ Building TideHunter from source files] ( #building-tidehunter-from-source-files )
42- - [ Pre-built binary executable file for Linux/Unix] ( #pre-built-binary-executable-file-for-linuxunix )
4343 - [ Getting started with toy example in ` test_data ` ] ( #getting-started-with-toy-example-in-test_data )
4444 - [ Usage] ( #usage )
4545 - [ To generate consensus sequences in FASTA format] ( #to-generate-consensus-sequences-in-fasta-format )
@@ -48,7 +48,6 @@ TideHunter ./test_data/test_50x4.fa > cons.fa
4848 - [ To generate full-length consensus sequences] ( #to-generate-full-length-consensus-sequences )
4949 - [ To generate unit sequences in FASTA format] ( #to-generate-unit-sequences-in-fasta-format )
5050 - [ To generate unit sequences in tabular format] ( #to-generate-unit-sequences-in-tabular-format )
51- - [ Commands and options] ( #commands-and-options )
5251 - [ Input] ( #input )
5352 - [ Adapter sequence] ( #adapter-sequence )
5453 - [ Output] ( #output )
@@ -76,6 +75,18 @@ On Linux/Unix and Mac OS, TideHunter can be installed via
7675conda install -c bioconda tidehunter
7776```
7877
78+ ### <a name =" binary " ></a >Pre-built binary executable file for Linux/Mac OS
79+ Linux x86_64:
80+ ```
81+ wget https://github.com/yangao07/TideHunter/releases/download/v1.5.6/TideHunter-v1.5.6_x64-linux.tar.gz
82+ tar -zxvf TideHunter-v1.5.6_x64-linux.tar.gz
83+ ```
84+ Mac OS arm64:
85+ ```
86+ wget https://github.com/yangao07/TideHunter/releases/download/v1.5.6/TideHunter-v1.5.6_arm64-macos.tar.gz
87+ tar -zxvf TideHunter-v1.5.6_arm64-macos.tar.gz
88+ ```
89+
7990### <a name =" build " ></a >Building TideHunter from source files
8091You can also build TideHunter from source files.
8192Make sure you have gcc (>=6.4.0) and zlib installed before compiling.
@@ -86,20 +97,6 @@ wget https://github.com/yangao07/TideHunter/releases/download/v1.5.6/TideHunter-
8697tar -zxvf TideHunter-v1.5.6.tar.gz
8798cd TideHunter-v1.5.6; make
8899```
89- Or, you can use ` git clone ` command to download the source code.
90- Don't forget to include the ` --recursive ` to download the codes of [ abPOA] ( https://github.com/yangao07/abPOA ) .
91- This gives you the latest version of TideHunter, which might be still under development.
92- ```
93- git clone --recursive https://github.com/yangao07/TideHunter.git
94- cd TideHunter; make
95- ```
96-
97- ### <a name =" binary " ></a >Pre-built binary executable file for Linux/Unix
98- If you meet any compiling issue, please try the pre-built binary file:
99- ```
100- wget https://github.com/yangao07/TideHunter/releases/download/v1.5.6/TideHunter-v1.5.6_x64-linux.tar.gz
101- tar -zxvf TideHunter-v1.5.6_x64-linux.tar.gz
102- ```
103100
104101## <a name =" start " ></a >Getting started with toy example in ` test_data `
105102```
@@ -131,59 +128,6 @@ TideHunter -u ./test_data/test_1000x10.fa > unit.fa
131128```
132129TideHunter -u -f 2 ./test_data/test_1000x10.fa > unit.out
133130```
134- ## <a name =" cmd " ></a >Commands and options
135- ```
136- Usage: TideHunter [options] in.fa/fq > cons.fa
137-
138- Options:
139- Seeding:
140- -k --kmer-length INT k-mer length (no larger than 16) [8]
141- -w --window-size INT window size, set as >1 to enable minimizer seeding [1]
142- -H --HPC-kmer use homopolymer-compressed k-mer [False]
143- Tandem repeat criteria:
144- -c --min-copy INT minimum copy number of tandem repeat (>=2) [2]
145- -e --max-diverg INT maximum allowed divergence rate between two consecutive repeats [0.25]
146- -p --min-period INT minimum period size of tandem repeat (>=2) [30]
147- -P --max-period INT maximum period size of tandem repeat (<=4294967295) [10K]
148- Scoring parameters for partial order alignment:
149- -M --match INT match score [2]
150- -X --mismatch INT mismatch penalty [4]
151- -O --gap-open INT(,INT) gap opening penalty (O1,O2) [4,24]
152- -E --gap-ext INT(,INT) gap extension penalty (E1,E2) [2,1]
153- TideHunter provides three gap penalty modes, cost of a g-long gap:
154- - convex (default): min{O1+g*E1, O2+g*E2}
155- - affine (set O2 as 0): O1+g*E1
156- - linear (set O1 as 0): g*E1
157- Adapter sequence:
158- -5 --five-prime STR 5' adapter sequence (sense strand) [NULL]
159- -3 --three-prime STR 3' adapter sequence (anti-sense strand) [NULL]
160- -a --ada-mat-rat FLT minimum match ratio of adapter sequence [0.80]
161- Output:
162- -o --output STR output file [stdout]
163- -m --min-len INT only output consensus sequence with min. length of [30]
164- -r --min-cov FLOAT|INT only output consensus sequence with at least R supporting units for all bases: [0.00]
165- if r is fraction: R = r * total copy number
166- if r is integer: R = r
167- -u --unit-seq only output unit sequences of each tandem repeat, no consensus sequence [False]
168- -l --longest only output consensus sequence of tandem repeat that covers the longest read sequence [False]
169- -F --full-len only output full-length consensus sequence. [False]
170- full-length: consensus sequence contains both 5' and 3' adapter sequence
171- *Note* only effective when -5 and -3 are provided.
172- -s --single-copy output additional single-copy full-length consensus sequence. [False]
173- *Note* only effective when -F is set and -5 and -3 are provided.
174- -f --out-fmt INT output format [1]
175- - 1: FASTA
176- - 2: Tabular
177- - 3: FASTQ
178- - 4: Tabular with quality score
179- for [3] and [4], qualiy score of each base represents the ratio of the consensus coverage to the # total copies.
180- Computing resource:
181- -t --thread INT number of threads to use [4]
182-
183- General options:
184- -h --help print this help usage information
185- -v --version show version number
186- ```
187131
188132## <a name =" input_output " ></a >Input
189133TideHunter works with FASTA, FASTQ, gzip'd FASTA(.fa.gz) and gzip'd FASTQ(.fq.gz) formats.
0 commit comments