diff --git a/README.md b/README.md index 2897e20..e08042e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,73 @@ # kleEpistasis Brute-force 3-way Interaction calculation for genetic studies + +Welcome to kleEpistasis. A tool for performing 3-way genetic interaction analysis. + +Contact: stefan.kleeberger@gmail.com (Stefan Kleeberger, Programmer), bmm@psych.mpg.de (Prof. Dr. Bertram Mueller-Myhsok, Supervisor) Max Planck Institute of Psychiatry, Munich, 2015 + +In order to perform brute-force statistical 3-way interaction tests on SNP data, you will have to provide your data in PLINK binary format and a Phenotype in PLINK alternate phenotype format. Please see "http://pngu.mgh.harvard.edu/~purcell/plink/data.shtml#bed" and "http://pngu.mgh.harvard.edu/~purcell/plink/data.shtml#pheno" for more information regarding file formats. + + + +Flags: + + +REQUIRED + +'-path [path]' Absolute or relative path to plink files in binary format (.bed .bim .fam) !>> without <> with <> with <