Skip to content

OpenMendel/VarianceComponentModels.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VarianceComponentModels

Build Status Build status Coverage Status codecov

This Julia package provides computational routines for fitting and testing variance component models. It is one component of the umbrella OpenMendel project.

Installation

Note: Three OpenMendel packages - SnpArrays, Search, and MendelBase must be installed before any Mendel analysis packages will run.

Within Julia, use the package manager to install MendelVarianceComponentModels:

Pkg.clone("[email protected]:OpenMendel/MendelVarianceComponentModels.jl.git")

This package supports Julia v0.4.

Data Files

To run this analysis package you will need to prepare a Control file and have your data files available. The Control file holds the names of your data files and any optional parameters for the analysis. Details on the general format and contents of the Control and data files can be found on the OpenMendel documentation page. Descriptions of the specific options available within the MendelVarianceComponentModels analysis package are in its documentation page.

There are example data files in the "docs" subfolder of the MendelVarianceComponentModels package, for example, ~/.julia/v0.4/MendelVarianceComponentModels/docs.

Running the Analysis

To run this analysis package, first launch Julia. Then load the package with the command:

 julia> using MendelVarianceComponentModels

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 the control file Control_file.txt use the command:

 julia> VarianceComponentModels("Control_file.txt")

Note: The package is called MendelVarianceComponentModels but the analysis function is called simply VarianceComponentModels.

Citation

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

Lange K, Papp JC, Sinsheimer JS, Sripracha R, Zhou H, Sobel EM (2013) Mendel: The Swiss army knife of genetic analysis programs. Bioinformatics 29:1568-1570.

Acknowledgments

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