about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorPjotr Prins2025-11-23 12:44:20 +0100
committerPjotr Prins2025-11-23 12:44:20 +0100
commitff196955e3ca5bdd671a44f852f42323d3828be2 (patch)
tree1a1a12dea794dff9df5f4ca991740cbaf48c992a /README.md
parent663778957ad37d5c7806d4f17c1f2e77b2b268fa (diff)
downloadpangemma-ff196955e3ca5bdd671a44f852f42323d3828be2.tar.gz
Adding comments
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2369f4e..3239ab9 100644
--- a/README.md
+++ b/README.md
@@ -46,8 +46,29 @@ WIP
 
 ## Run GEMMA
 
+Pangemma (for now) maintains a version of gemma and may support new features. Run the legacy version with:
+
+```
+gemma -h
+# compute Kinship matrix
+gemma -g ./example/mouse_hs1940.geno.txt.gz -p ./example/mouse_hs1940.pheno.txt \
+    -gk -o mouse_hs1940
+# run univariate LMM
+gemma -g ./example/mouse_hs1940.geno.txt.gz \
+    -p ./example/mouse_hs1940.pheno.txt -n 1 -a ./example/mouse_hs1940.anno.txt \
+    -k ./output/mouse_hs1940.cXX.txt -lmm -o mouse_hs1940_CD8_lmm
+```
+
 ### Debugging and optimization
 
+We use guix for debugging and development. Try something like
+
+```
+LD_LIBRARY_PATH=$GUIX_ENVIRONMENT/lib gdb --args  ./build/bin/Debug/gemma -g ./example/mouse_hs1940.geno.txt.gz \
+    -p ./example/mouse_hs1940.pheno.txt -n 1 -a ./example/mouse_hs1940.anno.txt \
+    -k ./output/mouse_hs1940.cXX.txt -lmm -o mouse_hs1940_CD8_lmm
+```
+
 ## Citing PanGEMMA
 
 PanGEMMA is not published yet.