Skip to content

Commit e2633d2

Browse files
authored
Update README.md
Use massage with examples
1 parent fba2f72 commit e2633d2

1 file changed

Lines changed: 50 additions & 2 deletions

File tree

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
# Identity
22

3-
Academic use: Affero general public license version 1.
3+
Identity 1.0 is developed by Hani Z. Girgis, PhD.
44

5-
Any restrictions to use for-profit or non-academics: Alternative commercial license is needed; please contact Dr. Hani Z. Girgis (hzgirgis at buffalo dot edu) for more information.
5+
This program calculates DNA sequence identity scores rapidly without alignment.
6+
7+
Copyright (C) 2020 Hani Z. Girgis, PhD
8+
9+
Academic use: Affero General Public License version 1.
10+
11+
Any restrictions to use for profit or non-academics: Alternative commercial license is required.
12+
13+
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
14+
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15+
16+
Please contact Dr. Hani Z. Girgis (hzgirgis@buffalo.edu) if you need more information.
17+
18+
Please cite the following paper:
19+
Identity: Rapid alignment-free prediction of sequence alignment identity scores using
20+
self-supervised general linear models. Hani Z. Girgis, Benjamin T. James, and Brian B.
21+
Luczak. NAR GAB, 2020.
22+
23+
List of parameters:
24+
-d: Required. Database file in FASTA format.
25+
-o: Required. Output file.
26+
-t: Required. Identity score threshold (between 0 & 0.99), below which pairs are not reported.
27+
-q: Optional. Query file in FASTA format. If no query(s) is provided, all versus all is
28+
performed on the database file.
29+
-c: Optional. Number of cores or hyperthreads. For the search mode, set this parameter to the
30+
number of cores not hyperthreads. For example, suppose your computer has 4 cores, each of
31+
which supports 2 hyperthreads. Set this parameter to 4 if you are using the search mode or
32+
to 8 if you are using the all-versus-all mode. By default, all hyperthreads are used.
33+
-r: Optional. Automatically relax the threshold according to the predictor error -- y (yes) or
34+
n (no). By default, it is enabled except if the threshold is 0.9 or higher.
35+
-l: Optional. Print academic license (Affero General Public License version 1) and exit -- y
36+
(yes) or n (no).
37+
-h: Optional. Print this help message.
38+
39+
Examples:
40+
1. To perform database search with a minimum identity score of 0.7
41+
identity -d databas.fasta -q query.fasta -o output.txt -t 0.7
42+
43+
2. To perform database search with a minimum identity score of 0.7 using 10 threads
44+
identity -d databas.fasta -q query.fasta -o output.txt -t 0.7 -c 10
45+
46+
3. To perform all versus all with a minimum identity score of 0.8
47+
identity -d databas.fasta -o output.txt -t 0.8
48+
49+
4. To perform all versus all with a minimum identity score of 0.8 with strict threshold
50+
identity -d databas.fasta -o output.txt -t 0.8 -r n
51+
52+
5. To print the academic lincense
53+
identity -l y

0 commit comments

Comments
 (0)