Skip to content

Commit ca7e7bf

Browse files
authored
Update README.md
1 parent 9d07577 commit ca7e7bf

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,40 @@
11
# MutScan
2-
Detect important mutations by scanning FastQ files directly
3-
* Ultra sensitive
4-
* 20X+ faster than normal pipeline (i.e. BWA + Samtools + GATK/VarScan/Mutect)
5-
* Very easy to use. Need nothing else. No alignment, no reference assembly, no variant call, no pileup...
6-
* Beautiful HTML report
7-
* Multi-threading support
8-
* Support both single-end and pair-end data
9-
* For pair-end data, MutScan will try to merge each pair, and do quality adjustment and error correction
2+
Detect, visualize and filter target mutations by scanning FastQ files directly
3+
* Ultra sensitive.
4+
* 50X+ faster than normal pipeline (i.e. BWA + Samtools + GATK/VarScan/Mutect).
5+
* Very easy to use. Need nothing else. No alignment, no reference assembly, no variant call, no...
6+
* Beautiful HTML report with informative pileup visualization.
7+
* Multi-threading support.
8+
* Support both single-end and pair-end data.
9+
* For pair-end data, MutScan will try to merge each pair, and do quality adjustment and error correction.
10+
* Able to scan the mutations in a VCF file, which can be used to visualize called variants.
11+
* Can be used to filter false-positive mutations, especially for INDEL.
1012

1113
# Sample report
1214
http://opengene.org/MutScan/report.html
1315

1416
# Download
17+
Get latest (may be not stable)
1518
```shell
1619
# download use http
1720
https://github.com/OpenGene/MutScan/archive/master.zip
1821

1922
# or download use git
2023
git clone https://github.com/OpenGene/MutScan.git
2124
```
25+
Get the stable releases
26+
https://github.com/OpenGene/MutScan/releases/latest
2227

2328
# Build
29+
MutScan only depends on `libz`, which is always available on Linux or Mac systems. If your system has no `libz`, install it first.
2430
```shell
2531
cd MutScan
2632
make
2733
```
2834

2935
# Usage
3036
```shell
31-
usage: mutscan -1 <read1_file> -2 <read2_file> -m <mutation_file> -h <html_report_file> -t <thread>
37+
usage: mutscan -1 <read1_file> -2 <read2_file> [options]...
3238
options:
3339
-1, --read1 read1 file name (string)
3440
-2, --read2 read2 file name (string [=])
@@ -38,6 +44,7 @@ options:
3844
-t, --thread worker thread number, default is 4 (int [=4])
3945
-k, --mark when mutation file is a vcf file, --mark means only process the records with FILTER column is M
4046
-l, --legacy use legacy mode, usually much slower but may be able to find a little more reads in certain case
47+
-o, --original output original reads in HTML and text output. If specified, MutScan will consume more memory and output bigger report files.
4148
-?, --help print this message
4249
```
4350
The plain text result, contains the detected mutations and their support reads, will be printed directly. You can use `>` to redirect output to a file, like:
@@ -87,7 +94,7 @@ mutscan -1 <read1_file_name> -2 <read2_file_name>
8794
```
8895
8996
# HTML output
90-
If `-h` or `--html` argument is given, then a HTML report will be generated, and written to the given filename. A sample report is given here:
97+
If `-h` or `--html` argument is given, then a HTML report will be generated, and written to the given filename. See http://opengene.org/MutScan/report.html for an example, and find its screenshot here:
9198
9299
![image](http://www.opengene.org/MutScan/indel.jpg)
93100
* An pileup of an indel is displayed above, from which we can find MutScan can make excellent pileup even in such highly repetitive area.

0 commit comments

Comments
 (0)