annotate SNV/SNVMix2_source/SNVMix2-v0.12.1-rc1/README @ 0:74f5ea818cea

Uploaded
author ryanmorin
date Wed, 12 Oct 2011 19:50:38 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
1 *** SNVMix2 ***
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
2
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
3 This version of SNVMix2 has has been tested under Linux and Mac OS X.
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
4
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
5 To build:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
6
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
7 > unzip -x ../SNVMix2-v{VERSION}.zip
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
8 > cd SNVmix2-v{VERSION}/
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
9 > make
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
10
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
11 Binary file is called "SNVMix2", for help run with -h flag
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
12
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
13 > ./SNVMix2 -h
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
14
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
15 You can copy that file to a preferred location.
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
16
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
17 SNVMix2 defaults to reading from standard input if flag '-i' is not specified,
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
18 so you can use it in pipe mode next to a MAQ or samtools pileup command, saving
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
19 storage space. Same applies for standard output and the "-o" flag while Classifying.
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
20
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
21 Parameter '-m <file>' is used to read the model parameters when Classifying (-C)
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
22 or write them in Train mode (-T)
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
23
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
24 Different models for base and mapping qualities are available using the "-t" flag,
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
25 SNVMix1 mode can be accessed by selecting "-t SNVMix1"
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
26
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
27 Pileup file should be generated with base and mapping qualities but without consensus,
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
28 such as the one obtained when running, with samtools-0.1.4:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
29 samtools pileup -s -l <in_list.txt> -f <ref.fa> <in.bam>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
30
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
31 or with maq-0.7.0:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
32 maq pileup -v <ref.bfa> <in.map>
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
33
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
34
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
35 A perl script is provided to filter SNVMix2 result according to a specified
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
36 threshold, help on this script can be found running:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
37
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
38 > ./misc/snvmix2summary.pl -h
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
39
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
40 This script can filter candidate SNVs using two methods specified by the '-c <TYPE>'
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
41 flag:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
42
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
43 '-c 2' Will consider only two classes, either homozygote for the reference allele
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
44 ( p(AA) ) or not ( p(AB) + p(BB) )
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
45
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
46 '-c 3' Will consider the three clases p(AA), p(AB), p(BB) separately
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
47
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
48
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
49 The output still still retains the unmodified probability values, so p_AB can still
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
50 be distinguished from p_BB in case '-c 2' is used.
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
51
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
52
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
53
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
54
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
55
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
56 Notes:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
57
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
58 A working gcc compiler is needed and under Linux libc >= 4.6.27 is required.
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
59
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
60 Be careful if you copy & paste pileup files, as some text editors tend to change
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
61 "tabs" for spaces, which is needed as the field delimiter. This can cause problems
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
62 in the parser.
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
63
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
64 //
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
65 Comments and Questions:
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
66 Sohrab Shah sshah@bccrc.ca
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
67 Rodrigo Goya rgoya@bcgsc.ca
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
68
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
69 //
74f5ea818cea Uploaded
ryanmorin
parents:
diff changeset
70 LICENSE: this software is distributed under the MIT license