Difference between revisions of "BamGenotypeCheck"

From Genome Analysis Wiki
Jump to navigationJump to search
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{| style="width:100%; background:#FF8989; margin-top:1.2em; border:1px solid #ccc;" |
 +
| style="width:100%; text-align:center; white-space:nowrap; color:#000;" |
 +
<div style="font-size:162%; border:none; margin:0; padding:.1em; color:#000;">This tool has been DEPRECATED, and replaced by [[VerifyBamID]]</div>
 +
|}
 +
 +
'''bamGenotypeCheck''' is a program that verifies whether the reads in particular file match previously known genotypes for an individual (or group of individuals).
 +
 +
 +
== Download bamGenotypeCheck  ==
 +
 +
To get a copy go to the [http://csg.sph.umich.edu//pha/karma/download/ Karma Download] download page.
 +
 +
== Build bamGenotypeCheck  ==
 +
 +
Karma (which includes bamGenotypeCheck) is designed to be reasonably portable.
 +
 +
However, since development occurs only on Ubuntu 9.10 x86 and x64 platforms, and later, there are likely other portability issues.
 +
 +
We support Karma only on Ubuntu 9.10 and later on 64-bit processors.
 +
 +
== Usage ==
 +
 +
A key step in any genetic analysis is to verify whether data being generated matches expectations. This program checks whether reads in a BAM file match previous genotypes for a specific sample.
 +
 +
Using a mathematical model that relates observed sequence reads to an hypothetical true genotype, bamGenotypeCheck tries to decide whether sequence reads match a particular individual or are more likely to be contaminated (including a small proportion of foreign DNA), derived from a closely related individual, or derived from a completely different individual.
 +
 
== Basic Usage Example ==
 
== Basic Usage Example ==
  
−
Here is an example of how laneCheck&nbsp;works:
+
Here is a typical command line:
  
−
   lanecheck --referencegenome NCBI36.fa --dbSNPfile dbSNP.txt  
+
   bamGenotypeCheck -r /data/local/ref/karma.ref/human.g1k.v37.fa \
−
            --lanefile lane.lst --pedfile test.ped --datfile test.dat --mapfile test.map --prefix result
+
              -k BAMfiles.txt -p test.ped -d test.dat -m test.map
  
 
== Command Line Options ==
 
== Command Line Options ==
Line 10: Line 36:
 
=== Input Files ===
 
=== Input Files ===
  
−
  --referencegenome ''referencegenome file''
+
  -r  ''genome reference in [http://en.wikipedia.org/wiki/Fasta_format simplified FASTA format]''
−
  --dbSNPfile      ''optional'' ''two-column'' ''dbsnp position file, will provide more accurate background mismatch rate if excluding dbSNP positions (e.g. 5 123456)''
+
  -a  ''allele Frequency file in [[MERLIN format]]''
−
  --lanefile        ''a list of lane file with path''
+
-p  ''pedigree file in [[MERLIN format]]''
−
  --pedfile        ''genotype information of the samples for checking ''
+
  -d  ''data file in [[MERLIN format]]''
−
  --datfile        ''a companion data file for pedigree file (each row: M snpname, e.g. M rs1234)''
+
  -m  ''map file in [[MERLIN format]]''
−
  --mapfile        ''a companion data file for pedigree file (each row: chr snpname pos, e.g. 5 rs1234 56789)''
+
 
−
Either standard [QTDT][http://www.example.com link title] or [LINKAGE][http://www.example.com link title] format. See Description here
+
  -k  ''a list of BAM files to check''
 +
  -c [int]  ''stop after reading [int] filtered sequence reads''
 +
-C [int] ''stop after reading [int] reads, filtered or not''
  
−
=== Basic Output Options ===
+
=== Output Options ===
  
−
  --prefix ''specify the prefix name of the output file''
+
  -v  ''verbose output''
  
−
=== Filtering&nbsp; ===
+
=== Filtering ===
  
−
  --minmapquality   ''reads with with mapquality falling below this threshold will be excluded''
+
  -b [int]   ''exclude bases with quality less than [int]''
−
  --genocount      ''the maximum number of genotypes compared''  
+
  -M [int]  ''exclude reads with map quality less than [int]''
−
  --verbose        ''print out detailed information for each hapmap position compared''
+
  -f [float] ''drop markers with minor allele frequency smaller than [float]''
−
  --coverage        ''print out the proportion of markers in the map file covered by at least one read''
+
  -F [int]  ''set custom BAM flags filter (not implemented at the moment)''
−
--countbysite    ''print out detailed mismatch counts for each base compared''
 
  
 
=== Other Options ===
 
=== Other Options ===
  
−
  --memorymap ''use memory map technique for efficient memory sharing of reference genome file''
+
  -e [float] '' set minimum error base error to [float]''
−
 
  
−
== Principle of Operation: ==
+
== Principle of Operation ==
  
−
The overall procedure is that the genotype identity checking program compares internal evidence from the sequence reads themselves to reference genotype information for a panel of candidate individuals. In the case of 1000 Genomes pilot data, these are HapMap genotypes from the same Coriell cell lines that are being sequenced. For each combination of [sequencing run x candidate individual] the program calculates the observed rate of mismatches at both "informative" and "background" locations and reports as "excess mismatch rate"
+
Each read group in a BAM file is evaluated independently. This means that in file with multiple read groups, problems will be flagged at the read group level (a plus). However, it also means that it might be hard to discern the correct assignment of read groups with very little data.
  
−
            excess rate  =  (informative rate  -  background rate).
+
For each aligned base that overlaps a known genotype, we calculate the probability the probability that it was derived from a particular known genotype. This comparison considers only bases that overlap previously known genotypes and that meet the base quality and mapping quality thresholds.
  
−
"Informative" locations are those where the candidate individual is homozygous, according to the HapMap genotype information, and base calls are compared to the HapMap homozygous allele, rather than to the genome reference sequence. "Background" locations are all sites not known to be polymorphic and not recorded in dbSNP if provided. &nbsp;A relative high background rate suggests possible problems in sample preparation or read mapping process.&nbsp;
+
Each individual in a pedigree has a different combination of genotypes, and bamGenotypeCheck will systematically search for the individual whose genotypes best match the observed read data.
  
−
<br>
+
For more about the technical details, see the page [[Verifying Sample Identities - Implementation]]
  
 
== TODO ==
 
== TODO ==
−
 
−
1. Separate the results by "Read group classifier".
 
−
 
−
The mapped .bam file may contains sequence data from different instrument runs.&nbsp;The read identifiers often are dot or colon-separated strings of the form 'run_name&lt;sep&gt;read_number'. The 'run_name' may be either an SRR / ERR identifier or the sequencing center's own alpha-numeric internal run identifier. Allow users to input&nbsp;extended regular expression such as '\(^[^.:]+\)[.:].*'&nbsp;hich matches just the part of each read identifier that is common to all reads from one instrument run and which differs between instrument runs.
 
−
 
−
2. Use model based approach to calculate probability of lane coming from the claimed individual in the index file given a pool of individuals. &nbsp;
 

Latest revision as of 11:11, 2 February 2017

This tool has been DEPRECATED, and replaced by VerifyBamID

bamGenotypeCheck is a program that verifies whether the reads in particular file match previously known genotypes for an individual (or group of individuals).


Download bamGenotypeCheck

To get a copy go to the Karma Download download page.

Build bamGenotypeCheck

Karma (which includes bamGenotypeCheck) is designed to be reasonably portable.

However, since development occurs only on Ubuntu 9.10 x86 and x64 platforms, and later, there are likely other portability issues.

We support Karma only on Ubuntu 9.10 and later on 64-bit processors.

Usage

A key step in any genetic analysis is to verify whether data being generated matches expectations. This program checks whether reads in a BAM file match previous genotypes for a specific sample.

Using a mathematical model that relates observed sequence reads to an hypothetical true genotype, bamGenotypeCheck tries to decide whether sequence reads match a particular individual or are more likely to be contaminated (including a small proportion of foreign DNA), derived from a closely related individual, or derived from a completely different individual.

Basic Usage Example

Here is a typical command line: 

  bamGenotypeCheck  -r /data/local/ref/karma.ref/human.g1k.v37.fa \
             -k BAMfiles.txt -p test.ped -d test.dat -m test.map

Command Line Options

Input Files

-r  genome reference in simplified FASTA format
-a  allele Frequency file in MERLIN format
-p  pedigree file in MERLIN format
-d  data file in MERLIN format
-m  map file in MERLIN format

-k  a list of BAM files to check
-c [int]  stop after reading [int] filtered sequence reads
-C [int]  stop after reading [int] reads, filtered or not

Output Options

-v  verbose output

Filtering

-b [int]   exclude bases with quality less than [int]
-M [int]   exclude reads with map quality less than [int]
-f [float] drop markers with minor allele frequency smaller than [float]
-F [int]   set custom BAM flags filter (not implemented at the moment)

Other Options

-e [float]  set minimum error base error to [float]

Principle of Operation

Each read group in a BAM file is evaluated independently. This means that in file with multiple read groups, problems will be flagged at the read group level (a plus). However, it also means that it might be hard to discern the correct assignment of read groups with very little data.

For each aligned base that overlaps a known genotype, we calculate the probability the probability that it was derived from a particular known genotype. This comparison considers only bases that overlap previously known genotypes and that meet the base quality and mapping quality thresholds.

Each individual in a pedigree has a different combination of genotypes, and bamGenotypeCheck will systematically search for the individual whose genotypes best match the observed read data.

For more about the technical details, see the page Verifying Sample Identities - Implementation

TODO

Retrieved from "http://genome.sph.umich.edu/w/index.php?title=BamGenotypeCheck&oldid=14614"