Skip to content

Commit cec2c07

Browse files
committed
add doc
1 parent 0e5a7bd commit cec2c07

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

Diff for: LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017 Qinhu Wang, Northwest A&F University
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

Diff for: README.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
ID operation tool (idot)
2+
------------------------
3+
4+
idot
5+
----
6+
```
7+
idot <command> [<arguments>]
8+
9+
Command: find find id_file matched lines in target_file
10+
diff find specific lines in id_file or target_file
11+
replace replace id in the target_file according to the id_file
12+
fasta fetch id_file match fasta sequences from all sequences
13+
```
14+
15+
16+
idot find
17+
---------
18+
```
19+
idot find [options] <id_file> <target_file>
20+
21+
Options: -d STR The delimiter character of fields, default <TAB>.
22+
Valid delimiters: comma (","), space ("\s"), or <TAB> ("\t")
23+
-f INT The field(s) that specified as ID column(s), default 1.
24+
Use comma (",") to specify multiple fields. e.g. -f 1,2
25+
-s STR The method used for ID sort. default: u.
26+
Available methods: sn - strint number
27+
s - string
28+
n - number
29+
u - unsorted (use id_file id order)
30+
t - use target_file id order
31+
r - reverse (in combination with others)
32+
-h Help message
33+
```
34+
35+
idot diff
36+
---------
37+
```
38+
idot diff [options] <id_file> <target_file>
39+
40+
Options: -d STR The delimiter character of fields, default <TAB>.
41+
Valid delimiters: comma (","), space ("\s"), or <TAB> ("\t")
42+
-f INT The field(s) that specified as ID column(s), default 1.
43+
Use comma (",") to specify multiple fields. e.g. -f 1,2
44+
-p INT Print the specific ID of file: 1 - id_file (default)
45+
2 - target_file
46+
-h Help message
47+
```
48+
49+
idot replace
50+
------------
51+
```
52+
idot replace <id_file> <target_file>
53+
```
54+
55+
idot fasta
56+
----------
57+
```
58+
Usage: idot fasta <id_file> <database_file>
59+
```
60+
61+
Author
62+
------
63+
Qinhu Wang ([email protected])
64+
65+
Copyright
66+
---------
67+
2017 (c) Qinhu Wang, Northwest A&F University
68+
69+
License
70+
-------
71+
MIT

0 commit comments

Comments
 (0)