Detect and visualize target mutations by scanning FastQ files directly
mutscan -1 R1.fq.gz -2 R2.fq.gz
conda install -c bioconda mutscan
This binary is only for Linux systems: http://opengene.org/MutScan/mutscan
# this binary was compiled on CentOS, and tested on CentOS/Ubuntu wget http://opengene.org/MutScan/mutscan chmod a+x ./mutscan
# get source (you can also use browser to download from master or releases) git clone https://github.com/OpenGene/MutScan.git # build cd mutscan make # Install sudo make installWindows version (may be not the latest version)
If you want to compile MutScan on Windows, you should use cygwin
. We already built one with cygwin-2.6.0/g++ 5.4, and it can be downloaded from: http://opengene.org/MutScan/windows_mutscan.zip
xxxx.html
and xxxx.html.files
and keep them in the same folder, then click xxxx.html
to view it in browser.mutscan.html
, and a folder mutscan.html.files
will be also generated.-s
or --standalone
to contain all mutations in a single HTML file. Be caution with this mode if you are scanning too many records (for example, scanning VCF), it will give you a very big HTML file and is not loadable by browser.JSON report is disabled by default. You can enable it by specifying a JSON file name using -j
or --json
. A JSON report is like this:
{ "command":"./mutscan -1 /Users/shifu/data/fq/S010_20170320003-4_ffpedna_pan-cancer-v1_S10_R1_001.fastq -2 /Users/shifu/data/fq/S010_20170320003-4_ffpedna_pan-cancer-v1_S10_R2_001.fastq -h z.html -j z.json -v --simplified=off ", "version":"1.14.0", "time":"2018-05-15 15:48:21", "mutations":{ "NRAS-neg-1-115258747-2-c.35G>C-p.G12A-COSM565":{ "chr":"chr1", "ref":["TGGATTGTCAGTGCGCTTTTCCCAACACCA","G","CTGCTCCAACCACCACCAGTTTGTACTCAG"], "reads":[ { "breaks":[31,61,62,76], "seq":"ATATTCATCTACAAAGTGGTTCTGGATTAGCTGGATTGTCAGTGCGCTTTTCCCAACACCAGCTGCTCCAACCACC", "qual":"eeeeeiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiieiiiiiiiiiiieieeeee" }, { "breaks":[31,61,62,76], "seq":"ATATTCATCTACAAAGTGGTTCTGGATTAGCTGGATTGTCAGTGCGCTTTTCCCAACACCAGCTGCTCCAACCACC", "qual":"eeeeeiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiieeeee" } ] }, "PIK3CA-pos-3-178936082-9-c.1624G>A-E542K-COSM760":{ "chr":"chr3", "ref":["AAAGCAATTTCTACACGAGATCCTCTCTCT","A","AAATCACTGAGCAGGAGAAAGATTTTCTAT"], "reads":[ { "breaks":[22,52,53,83], "seq":"GGAAAATGACAAAGAACAGCTCAAAGCAATTTCTACACGAGATCCTCTCTCTAAAATCACTGAGCAGGAGAAAGATTTTCCAAAGATGTTTCTCAGAACGCTGCAGTCTGCAATTTGTATGAATTCCC", "qual":"eeeeeiiiQiiiiiieiiiieiSeiiiiiie`iiii`i`iiiiiiiiiiiiii`iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiaiiiiiiiiiiiiiiiiiieiiiiiieeeee" }, { "breaks":[0,27,28,58], "seq":"GCAATTTCTACACGAGATCCTCTCTCTAAAATCACTGCGCAGGAGAAAGATTTTCTATGGACCACAGGTAAGTGCTAAAATGGAGATTCTCTGTTTCTTTTTCTTTATTACAGAAAAAATAACTGACTTTGGCTGATCTCAGCATGTTTTTACCATACC", "qual":"AAAAAEEEEiieiiieiiiiiiiiiieiiiiiiiie``iiiiiieiiiiiiiiiieiiiieiieieeiiiSiiiiiieiiiiiiiiiiiiiieiiiiiSiiiiiiiiiiiiieiiiiiiiiiiii`ieiiieiii`ieiiiii`eS``eieEEEAAAAA" } ] } } }
usage: mutscan -1 <read1_file> -2 <read2_file> [options]... options: -1, --read1 read1 file name, required -2, --read2 read2 file name -m, --mutation mutation file name, can be a CSV format or a VCF format -r, --ref reference fasta file name (only needed when mutation file is a VCF) -h, --html filename of html report, default is mutscan.html in work directory -j, --json filename of JSON report, default is no JSON report (string [=]) -t, --thread worker thread number, default is 4 -S, --support min read support required to report a mutation, default is 2. -k, --mark when mutation file is a vcf file, --mark means only process the records with FILTER column is M -l, --legacy use legacy mode, usually much slower but may be able to find a little more reads in certain case -s, --standalone output standalone HTML report with single file. Don't use this option when scanning too many target mutations (i.e. >1000 mutations) -n, --no-original-reads dont output original reads in HTML and text output. Will make HTML report files a bit smaller -?, --help print this message
The plain text result, which contains the detected mutations and their support reads, will be printed directly. You can use >
to redirect output to a file, like:
mutscan -1 <read1_file_name> -2 <read2_file_name> > result.txt
MutScan generate a very informative HTML file report, default is mutscan.html
in the work directory. You can change the file name with -h
argument, like:
mutscan -1 <read1_file_name> -2 <read2_file_name> -h report.html
For single-end sequencing data, -2
argument is omitted:
mutscan -1 <read1_file_name>
-t
argument specify how many worker threads will be launched. The default thread number is 4
. Suggest to use a number less than the CPU cores of your system.
-m
, can be a CSV file
, or a VCF file
.-m
specified, MutScan will use the built-in default mutation file with about 60 cancer related mutation points.A CSV file with columns of name
, left_seq_of_mutation_point
, mutation_seq
, right_seq_of_mutation_point
and chromosome(optional)
#name, left_seq_of_mutation_point, mutation_seq, right_seq_of_mutation_point, chromosome
NRAS-neg-1-115258748-2-c.34G>A-p.G12S-COSM563, GGATTGTCAGTGCGCTTTTCCCAACACCAC, T, TGCTCCAACCACCACCAGTTTGTACTCAGT, chr1
NRAS-neg-1-115252203-2-c.437C>T-p.A146V-COSM4170228, TGAAAGCTGTACCATACCTGTCTGGTCTTG, A, CTGAGGTTTCAATGAATGGAATCCCGTAAC, chr1
BRAF-neg-7-140453136-15-c.1799T>A -V600E-COSM476, AACTGATGGGACCCACTCCATCGAGATTTC, T, CTGTAGCTAGACCAAAATCACCTATTTTTA, chr7
EGFR-pos-7-55241677-18-c.2125G>A-p.E709K-COSM12988, CCCAACCAAGCTCTCTTGAGGATCTTGAAG, A, AAACTGAATTCAAAAAGATCAAAGTGCTGG, chr7
EGFR-pos-7-55241707-18-c.2155G>A-p.G719S-COSM6252, GAAACTGAATTCAAAAAGATCAAAGTGCTG, A, GCTCCGGTGCGTTCGGCACGGTGTATAAGG, chr7
EGFR-pos-7-55241707-18-c.2155G>T-p.G719C-COSM6253, GAAACTGAATTCAAAAAGATCAAAGTGCTG, T, GCTCCGGTGCGTTCGGCACGGTGTATAAGG, chr7
testdata/mutations.csv
gives an example of CSV-format mutation file
A standard VCF can be used as a mutation file, with file extension .vcf
or .VCF
. If the mutation file is a VCF file, you should specify the reference assembly file
by -r <ref.fa>
. For example the command can be:
mutscan -1 R1.fq -2 R2.fq -m target.vcf -r hg19.fa
If you want to run MutScan with BAM/CRAM files, you can use samtools
to convert them to FASTQ files using samtools fastq
command, both single-end and paired-end data are supported by latest version of samtools fastq
.
MutScan
requires at least 50 bp long reads, if your reads are too short, do not use it-S 1
or --support=1
in the commandShifu Chen, Tanxiao Huang, TieXiang Wen, Hong Li, Mingyan Xu and Jia Gu. MutScan: fast detection and visualization of target mutations by scanning FASTQ data. BMC Bioinformatics. https://doi.org/10.1186/s12859-018-2024-6
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4