annotate README.rst @ 3:90c9eb133c86

More integer checking fixes.
author Daniel Blankenberg <dan@bx.psu.edu>
date Mon, 16 Sep 2013 10:16:02 -0400
parents 0fa83c466e9d
children 907b40517289
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
1 This repository contains the **Naive Variant Caller** tool.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
2
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
3 ------
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
4
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
5 **What it does**
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
6
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
7 This tool is a naive variant caller that processes aligned sequencing reads from the BAM format and produces a VCF file containing per position variant calls. This tool allows multiple BAM files to be provided as input and utilizes read group information to make calls for individual samples.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
8
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
9 User configurable options allow filtering reads that do not pass mapping or base quality thresholds and minimum per base read depth; user's can also specify the ploidy and whether to consider each strand separately.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
10
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
11 In addition to calling alternate alleles based upon simple ratios of nucleotides at a position, per base nucleotide counts are also provided. A custom tag, NC, is used within the Genotype fields. The NC field is a comma-separated listing of nucleotide counts in the form of <nucleotide>=<count>, where a plus or minus character is prepended to indicate strand, if the strandedness option was specified.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
12
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
13
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
14 ------
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
15
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
16 **Inputs**
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
17
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
18 Accepts one or more BAM input files and a reference genome from the built-in list or from a FASTA file in your history.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
19
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
20
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
21 **Outputs**
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
22
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
23 The output is in VCF format.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
24
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
25 Example VCF output line, without reporting by strand:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
26 ``chrM 16029 . T G,A,C . . AC=15,9,5;AF=0.00155311658729,0.000931869952371,0.000517705529095 GT:AC:AF:NC 0/0:15,9,5:0.00155311658729,0.000931869952371,0.000517705529095:A=9,C=5,T=9629,G=15,``
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
27
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
28 Example VCF output line, when reporting by strand:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
29 ``chrM 16029 . T G,A,C . . AC=15,9,5;AF=0.00155311658729,0.000931869952371,0.000517705529095 GT:AC:AF:NC 0/0:15,9,5:0.00155311658729,0.000931869952371,0.000517705529095:+T=3972,-A=9,-C=5,-T=5657,-G=15,``
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
30
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
31 **Options**
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
32
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
33 Reference Genome:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
34
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
35 Ensure that you have selected the correct reference genome, either from the list of built-in genomes or by selecting the corresponding FASTA file from your history.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
36
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
37 Restrict to regions:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
38
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
39 You can specify any number of regions on which you would like to receive results. You can specify just a chromosome name, or a chromosome name and start postion, or a chromosome name and start and end position for the set of desired regions.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
40
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
41 Minimum number of reads needed to consider a REF/ALT:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
42
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
43 This value declares the minimum number of reads containing a particular base at each position in order to list and use said allele in genotyping calls. Default is 0.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
44
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
45 Minimum base quality:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
46
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
47 The minimum base quality score needed for the position in a read to be used for nucleotide counts and genotyping. Default is no filter.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
48
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
49 Minimum mapping quality:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
50
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
51 The minimum mapping quality score needed to consider a read for nucleotide counts and genotyping. Default is no filter.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
52
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
53 Ploidy:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
54
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
55 The number of genotype calls to make at each reported position.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
56
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
57 Only write out positions with with possible alternate alleles:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
58
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
59 When set, only positions which have at least one non-reference nucleotide which passes declare filters will be present in the output.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
60
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
61 Report counts by strand:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
62
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
63 When set, nucleotide counts (NC) will be reported in reference to the aligned read's source strand. Reported as: <strand><BASE>=<COUNT>.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
64
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
65 Choose the dtype to use for storing coverage information:
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
66
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
67 This controls the maximum depth value for each nucleotide/position/strand (when specified). Smaller values require the least amount of memory, but have smaller maximal limits.
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
68
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
69 +--------+----------------------------+
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
70 | name | maximum coverage value |
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
71 +========+============================+
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
72 | uint8 | 255 |
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
73 +--------+----------------------------+
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
74 | uint16 | 65,535 |
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
75 +--------+----------------------------+
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
76 | uint32 | 4,294,967,295 |
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
77 +--------+----------------------------+
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
78 | uint64 | 18,446,744,073,709,551,615 |
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
79 +--------+----------------------------+
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
80
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
81
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
82 ------
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
83
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
84 **Citation**
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
85
0fa83c466e9d Create naive_variant_caller repository
blankenberg
parents:
diff changeset
86 If you use this tool, please cite Blankenberg D, et al. *In preparation.*