Introduction to Kelvin

Kelvin is a program suite for analysis of genetic data. It is based on the PPL framework1, 2, 3, and produces output on the posterior probability (0,..,1) scale.

Kelvin consists of a binary core and Perl front-end combination genetic data analysis program based on the PPL framework, with likelihoods calculated via the Elston-Stewart algorithm4. It is stable software, and has been tested on a number of hardware platforms.

A discussion of the guiding philosophy of Kelvin and details on the underlying statistical methods can be found in the following reference:

Vieland, V.J., et al. Kelvin: a Software Package for Rigorous Measurement of Statistical Evidence in Human Genetics. Hum Hered 2011;72(4):276-88. Epub 2011 Dec 23. PMID:22189470

Details on the usage of Kelvin can be found in our detailed usage documentation; this document provides a general overview and "getting started" information.

Prerequisites

Kelvin has been tested and run on several platforms, but the reference and development platform is CentOS 6 (or any other Linux distribution of similar vintage).

To install Kelvin, you will also need a working C compiler (GCC will do and is tested; ICC (the Intel C Compiler) has also been tested). You will also almost certainly want libgsl (the GNU Scientific Library); compiling without GSL is an option but not supported by default. pkg-config is also needed; normally this is included in any install of Linux development tools, but we've seen instances where it wasn't.

Running Kelvin requires libgsl (if compiled with same) and Perl 5.8 (or any later version)

Installation

  1. Edit the Makefile as follows: BINDIR: This should point to where Kelvin and related modules and utility scripts should be located. The default is /usr/local/share/kelvin PATHDIR: This should point to a directory on your $PATH where the Kelvin program will be linked. The default is /usr/local/bin OWNER and GROUP: These should be the owner and group IDs for the Kelvin programs and utility files. The defaults are root for both.

  2. Run make install. Kelvin will be built, assembled, and installed in the location you specified in the Makefile.

  3. (optional) Verify the build worked by running make check (for a quick check) or make test (for a more involved one).

Uninstallation may be done by running make uninstall; this simply deletes all files that were installed.

Using Kelvin

Kelvin requires four input data files, inspired by the de-facto standard formats employed by the LINKAGE program5. Details of the formats can be found in our detailed usage documentation under "Input Data File Formats". Examples are given here showing an affected sib-pair family with three markers:

Kelvin also requires a configuration file. Additional details on creation of same can be found in the detailed usage documentation under "Preparation and Analysis Considerations" and the "Configuration File Reference".

Once your configuration file is created, invoke Kelvin as Kelvin <configfile>.

Visualizing Results

Kelvin-formatted PPL output can be easily visualized using our graphing application, Kelviz. Kelviz is distributed separately; information on same can be found in the Kelviz documentation and downloads can be found on the Kelvin website.

References

  1. Smith, C.A.B. Some comments on the statistical methods used in linkage investigations. Am J Hum Genet 11, 289-304 (1959).
  2. Vieland, V.J. Bayesian linkage analysis, or: how I learned to stop worrying and love the posterior probability of linkage. Am J Hum Genet 63, 947-54 PMID: 9758634 (1998).
  3. Vieland, V.J. Thermometers: something for statistical geneticists to think about. Hum Hered 61, 144-56 PMID: 16770079 (2006).
  4. Elston, R.C. & Stewart, J. A general model for the genetic analysis of pedigree data. Hum Hered 21, 523-42 (1971).
  5. Ott, J. (1976). A computer program for linkage analysis of general human pedigrees. Am. J. Hum. Genet. 28, 528-529.