MendelKinship

Documentation	Build Status	Code Coverage

This Julia package computes genetic kinship and other identity coefficients. MendelKinship is one component of the umbrella OpenMendel project.

Installation

Download and install Julia. Within Julia, copy and paste the following:

using Pkg
Pkg.add(PackageSpec(url="https://github.com/OpenMendel/SnpArrays.jl.git"))
Pkg.add(PackageSpec(url="https://github.com/OpenMendel/MendelSearch.jl.git"))
Pkg.add(PackageSpec(url="https://github.com/OpenMendel/MendelBase.jl.git"))
Pkg.add(PackageSpec(url="https://github.com/OpenMendel/MendelKinship.jl.git"))

This package supports Julia v1.0+.

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 MendelBase documentation page. Descriptions of the specific options available within the MendelKinship analysis package are in its documentation page. The old documentation can be accessed here

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

Running the Analysis

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

 julia> using MendelKinship

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> Kinship("Control_file.txt")

Note: The package is called MendelKinship but the analysis function is called simply Kinship.

Citation

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

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. OPENMENDEL: a cooperative programming project for statistical genetics. Hum Genet. 2020 Jan;139(1):61-71. doi: 10.1007/s00439-019-02001-z. Epub 2019 Mar 26. PMID: 30915546; PMCID: PMC6763373.

Acknowledgments

This project has been supported by the National Institutes of Health under awards R01GM053275, R01HG006139, R25GM103774, and 1R25HG011845.