Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 5.5 KB

index.md

File metadata and controls

66 lines (39 loc) · 5.5 KB
Raw

OpenMendel Project

OpenMendel is an open source project implemented in the Julia programming language that comprises a set of packages for statistical analysis to solve a variety of genetic problems. OpenMendel is the open source version of Mendel, a comprehensive package for exact statistical genetic analysis of qualitative and quantitative traits. OpenMendel currently provides the analysis options listed below, with additional options under development. Each analysis option is a separate Julia package. We invite the genetics community to contribute to the OpenMendel Project..

Analysis Options:

  • AIM Selection selects the SNPs that are most informative at predicting ancestry for your data — the best Ancestry Informative Markers (AIMs). [Package name: MendelAimSelection.]
  • Estimate Frequencies calculates a likelihood-based estimate of allele frequencies. [Package name: MendelEstimateFrequencies.]
  • Gamete Competition implements a gamete competition analysis, which is a generalization of the TDT analysis. [Package name: MendelGameteCompetition.]
  • Gene Dropping performs gene dropping with several useful options for the output. [Package name: MendelGeneDropping.]
  • Genetic Counseling performs risk calculations for genetic counseling problems. [Package name: MendelGeneticCounseling.]
  • GWAS performs standard Genome-wide Association Studies. [Package name: MendelGWAS.]
  • Kinship computes kinship and other identity coefficients. [Package name: MendelKinship.]
  • Location Scores maps a trait via the method of Location Scores, i.e., multipoint linkage analysis. [Package name: MendelLocationScores.]
  • Two Point Linkage performs two-point linkage analysis. [Package name: MendelTwoPointLinkage.]

Utilities

OpenMendel also includes the following utility packages:

  • MendelBase contains the base functions of OpenMendel.
  • MendelSearch is a program for function optimization. Search permits bounds and linear constraints to be imposed on parameters and, in statistical applications, computes asymptotic standard errors and correlations of parameter estimates.
  • SnpArrays provides utilities for handling compressed storage of biallelic SNP data.
  • VarianceComponentModels provides utilities for fitting and testing variance components models, also known as linear mixed models.

Installation

Note: The three OpenMendel packages (1) SnpArrays, (2) MendelSearch, and (3) MendelBase must be installed before any other OpenMendel package will run. It is easiest if these three packages are installed in the above order and before any other OpenMendel package.

Within Julia, use the package manager to install an OpenMendel package, for example, to install MendelBase, use the command:

pkg> add https://github.com/OpenMendel/MendelBase.jl

All OpenMendel packages support Julia v1.0+.

Data Files

To run an analysis package you will need to prepare a Control file and have your data files available. The Control file holds your data filenames and any optional parameters for the analysis. Details on the format and contents of the Control and data files can be found in the MendelBase documentation page. Descriptions of the relevant parameters (keywords) available within each analysis package are in its documentation page (see the links above).

There are example data files in the "data" subfolder of each Mendel package.

Running the Analysis

To run an analysis package, first launch Julia. Then load the package, for example MendelGWAS, with the command:

 julia> using MendelGWAS

Next, if necessary, change to the directory containing your files, for example,

 julia> cd("~/path/to/data/files/")

Finally, to run the analysis using the parameters in your Control file, for example, Control_file.txt, use the command:

 julia> GWAS("Control_file.txt")

Note: Mendel analysis packages are named with the Mendel prefix, for example, MendelGWAS, but the actual analysis functions do not have the prefix, for example, GWAS.

Citation

If you use this analysis package in your research, please cite the following reference in resulting publications:

OPENMENDEL: a cooperative programming project for statistical genetics. Zhou H, Sinsheimer JS, Bates DM, Chu BB, German CA, Ji SS, Keys KL, Kim J, Ko S, Mosher GD, Papp JC, Sobel EM, Zhai J, Zhou JJ, Lange K. Hum Genet. 2019 Mar 26. doi: 10.1007/s00439-019-02001-z. [Epub ahead of print] PMID: 30915546

Acknowledgments

This project is supported by the National Institutes of Health under NIGMS awards R01GM053275 and R25GM103774 and NHGRI award R01HG006139.