Heu-MCHC

Heu-MCHC

A fast and accurate heuristic algorithm for the haplotype inference problem on pedigree data with recombinations and mutations

by Yuri Pirola and Tao Jiang

Current release: v1.0.2 (June 1, 2011)


Introduction

Heu-MCHC is a fast and accurate heuristic for the Minimum-Change Haplotype Configuration (MCHC) problem, i.e. a combinatorial formulation of the haplotype inference problem on pedigree data where the total number of recombinations and point mutations has to be minimized.

Reference

Please cite the following paper when using Heu-MCHC.

Yuri Pirola, Paola Bonizzoni, and Tao Jiang.
An Efficient Algorithm for Haplotype Inference on Pedigrees with Recombinations and Mutations.
IEEE/ACM Transactions on Computational Biology and Bioinformatics, in press (2011). Link

A preliminary version of this work, entitled Haplotype Inference on Pedigrees with Recombinations and Mutations, appeared in Algorithms in Bioinformatics, 10th Int. Workshop, WABI 2010, Liverpool UK, Sep 6-8, 2010, Proceedings. V. Moulton and M. Singh (Ed.). Springer. Vol. 6293 pp. 148-161 (2010). Link

Download and Installation

Heu-MCHC is mainly distributed on source form but a pre-built binary package is also provided for your convenience.

Using a Pre-Built Binary Package

The binary package is available only for Linux 64-bit operating systems (fully tested on Ubuntu 10.04 x64) at the AlgoLab web site. Please compile the program from source if you need the binaries for different operating systems and/or architectures.

The binary package provides an implementation of Heu-MCHC in different flavors, denoted by a suffix of the program name. Below we list the flavors currently available:

Compiling from Source

The source code of Heu-MCHC is distributed under an open-source license (see below) at the yp/Heu-MCHC repository hosted by GitHub. The repository can be explored using the GitHub web interface at https://github.com/yp/Heu-MCHC.

Downloading the Source Code

The latest stable version of ZRHC-* can be downloaded in either .tar.gz or in .zip format. Previous stable releases can be downloaded from https://github.com/yp/Heu-MCHC/downloads.

It is also possible to clone the entire repository using the following command:

$ git clone git://github.com/yp/Heu-MCHC.git

Or, if you have a GitHub account, you can fork the project from the repository web page.

Compilation

The compilation process is divided in two steps:

  1. Compilation and installation of the m4ri library
  2. Compilation of the program Heu-MCHC
Compilation and installation of the m4ri library

In this project, we use a slightly modified version of the m4ri library which is included in the pers-lib/m4ri/ directory. Assuming that the required dependencies are satisfied, it suffices to use the following commands:

$ cd pers-lib/m4ri
$ ./configure --prefix=${PWD}/../local/
$ make && make install
$ cd ../..
Compilation of the program Heu-MCHC

As explained above, Heu-MCHC can be compiled in different flavors by setting some environment variables during the invocation of the make process. The most common combination of flavors can be produced by issuing the following command:

$ make STATUS=production  \
       LINKING=static  \
       EXT_DEFINE="-DMAX_TENT=10"  \
       MATH_LIB=none  \
       RECOMBINATIONS=yes  \
       MUTATIONS=yes  \
       reall

A faster alternative that uses the Framewave library can be produced by the following command:

$ make STATUS=production  \
       LINKING=static  \
       EXT_DEFINE="-DMAX_TENT=10"  \
       MATH_LIB=framewave  \
       RECOMBINATIONS=yes  \
       MUTATIONS=yes  \
       reall

The various environment variables and their values are quite self-explicative: please refer to the Makefile for further information.

The simple script ./scripts/deploy.sh automatically creates a directory containing the binaries compiled for every interesting combination of flavors (as described above).

Usage

Heu-MCHC is a software pipeline composed by two distinct steps:

To infer haplotypes starting from a genotyped pedigrees, both programs have to be used. First, we must invoke ped-hi which reads from the standard input the genotyped pedigree (please refer below for the description of the file format) and writes the predicted variation events to a file whose name has been specified as first command-line parameter. During the execution, ped-hi prints to standard error a description of the steps it performs. For example, with the following command line

$ ./ped-hi out-events.txt  \
           < genotyped-pedigree.txt  \
           2> log-ped-hi.txt

the program reads the genotyped pedigree from file genotyped-pedigree.txt, writes the predicted events to the file out-events.txt, and logs its activities to the file log-ped-hi.txt.

Second, we must invoke to-hap in order to recover a set of haplotypes which induces the predicted variation events. Program to-hap requires two parameters specified by means of the two flags -p and -e. Flag -p specifies the name of the file which describes the genotyped pedigree, while flag -e specifies the name of the file which contains the set of predicted variation events. To read one of the two files from standard input, we must specify - as filename. A consistent haplotype configuration is printed to standard output if the input data are valid, otherwise it terminates with an error. Like ped-hi, to-hap prints to standard error a description of the steps it performs.

For example, if the genotyped pedigree is described in file genotyped-pedigree.txt, the following commands perform the complete haplotype inference process.

$ ./ped-hi out-events.txt  \
           < genotyped-pedigree.txt  \
           2> log-ped-hi.txt
$ ./to-hap -p genotyped-pedigree.txt  \
           -e out-events.txt  \
           > out-haplotypes.txt  \
           2> log-to-hap.txt

File Formats

Genotyped Pedigrees

The genotyped pedigree is described by a single file, which contains both the pedigree structure and the set of genotypes. We describe the file format by a simple example.

2
7
#genotypes
10
02
11
22
22
22
22
#pedigree
0 1 4
2 3 5
4 5 6
#end

The first row specifies the number of loci (2, in this case) over which the genotypes are defined. The second row (7, in this case) specifies the pedigree size (i.e., the number of its members). Rows starting with # are considered as comments and are discarded. Genotypes are specified from the third row (discarding comments). Each row represents the multi-locus genotype of a single individual and genotypes are encoded as follows: 0=major allele homozygous, 1=minor allele homozygous, 2=heterozygous. The first genotype (the one in third row) is associated to individual 0, the second genotype (fourth row) is associated to individual 1, and so on. After all the genotypes have been described, the file specifies the pedigree structure by means of a series of triplets (each one on a single row). Each triplet specifies a single trio, where the first number is the identifier of the father, the second one is the identifier of the mother, and the third one is the identifier of the child. Identifiers start from 0 and are associated to genotypes as described above.

Sets of Variation Events

A set of variation events is described by a file containing a series of rows with the following structure:

= VAR i j k

where:

A row which does not conform to such a structure is silently ignored.

Haplotype Configuration

A haplotype configuration is described by a space-separated file in which rows have the following structure:

i T "remaining"

where:

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Contacts

Please contact Yuri Pirola for additional information.
E-mail: yuri.pirola@gmail.com
Web page: http://bimib.disco.unimib.it/index.php/Pirola_Yuri

Fork me on GitHub