@@ -18,8 +18,77 @@ For ease of use, you can append the configuration to your shell config file.
18
18
19
19
## Usage
20
20
21
+ ```
22
+ Usage:
23
+ bioview fq <file> [--config-file=<config_file>] [--hist=<yes/no>] [--color=<yes/no>] [--phred=<33/64>] [--delimiter=<yes/no>]
24
+ bioview fa <file> [--config-file=<config_file>] [--color=<yes/no>] [--type=<dna/rna/protein>]
25
+ bioview sam <file> [--config-file=<config_file>] [--hist=<yes/no>] [--color=<yes/no>] [--phred=<33/64>] [--multiline=<yes/no>]
26
+ bioview color-atla
27
+ bioview example-config
28
+ bioview (-h | --help)
29
+ ```
30
+
31
+ ### Example:
32
+
33
+ View fastq file:
34
+
35
+ ``` bash
36
+ $ biobiew fq example.fq | less -S
37
+ ```
38
+
39
+ View fasta file:
40
+
41
+ ``` base
42
+ $ bioview fa example_dna.fa | less -S
43
+ ```
44
+
45
+ View fasta file(protein record):
46
+
47
+ ``` bash
48
+ $ bioview fa example_protein.fa | less -S
49
+ ```
50
+
51
+ View sam file:
52
+
21
53
``` bash
22
- $ bioview fq example.fq | less -S
54
+ $ bioview sam example_sam.sam | less -S
55
+ ```
56
+
57
+ View sam file(multiline format):
58
+
59
+ ``` bash
60
+ $ bioview sam example_sam.sam --multiline | less -S
61
+ ```
62
+
63
+ Use '-' to read from stdin:
64
+
65
+ ``` bash
66
+ $ samtools view -h example.bam | bioview sam - | less -S
67
+ ```
68
+
69
+ ### bio-less
70
+
71
+ Use the ` bio-less ` function defined in the [ shell configuration] ( ./shell_config/bash_config.bash ) , it let you use bioView more conveniently.
72
+
73
+ ```
74
+ Usage:
75
+ bio-less <*.fq/*.fa/*.sam/*.bam>
76
+ fq-less <*.fq>
77
+ fa-less <*.fa>
78
+ sam-less <*.sam>
79
+ ```
80
+
81
+ For example:
82
+
83
+ ``` bash
84
+ $ bio-less example.fq
85
+ ```
86
+
87
+ This is equal to: ` bioview fq example.fq | less -S `
88
+
89
+ ```
90
+ $ fq-less example.fq # equal to `bioview fq example.fq | less -S`
91
+ $ samtools view -h example.bam | sam-less - # equal to `samtools view -h example.bam | bioview sam - | less -S`
23
92
```
24
93
25
94
## Theme
@@ -85,15 +154,9 @@ You need [install Nim](https://nim-lang.org/install.html) firstly.
85
154
86
155
### Compile the code
87
156
88
- Install the dependancy nim package:
89
-
90
- ``` bash
91
- $ nimble install docopt
92
- ```
93
-
94
157
Compilation:
95
158
96
- ``` bash
159
+ ``` bash
97
160
$ git clone https://github.com/Nanguage/bioView.git
98
161
$ cd bioView
99
162
$ mkdir bin
@@ -102,7 +165,7 @@ $ nim c -d:release -o ./bin/bioview src/main.nim
102
165
103
166
Unit test:
104
167
105
- ``` bash
168
+ ``` bash
106
169
$ ./test.sh # test all moudles
107
170
$ ./test.sh fastq_utils # test the fastq_utils.nim moudle
108
171
```
0 commit comments