about summary refs log tree commit diff
path: root/scripts/lmdb_matrix.py
diff options
context:
space:
mode:
authorMunyoki Kilyungi2025-07-14 16:49:14 +0300
committerBonfaceKilz2025-07-16 22:50:04 +0300
commit1c6a0f8f60bd48ae26b4238867e9e1e1a8e2671b (patch)
tree006736bfad4cc3fa0d316af21d2dcb330ac94cab /scripts/lmdb_matrix.py
parentd628fa7d594c462b11107b243b416e395d9fcd1b (diff)
downloadgenenetwork3-1c6a0f8f60bd48ae26b4238867e9e1e1a8e2671b.tar.gz
Add module doc-string.
Signed-off-by: Munyoki Kilyungi <me@bonfacemunyoki.com>
Diffstat (limited to 'scripts/lmdb_matrix.py')
-rw-r--r--scripts/lmdb_matrix.py14
1 files changed, 14 insertions, 0 deletions
diff --git a/scripts/lmdb_matrix.py b/scripts/lmdb_matrix.py
index 451976b..79d3197 100644
--- a/scripts/lmdb_matrix.py
+++ b/scripts/lmdb_matrix.py
@@ -1,3 +1,17 @@
+"""This scripts reads and store genotype files to an LMDB store.
+Similarly, it can be use to read this data.
+
+Example:
+
+guix shell python-click python-lmdb python-wrapper python-numpy -- \
+     python lmdb_matrix.py import-genotype \
+     <path-to-genotype-file> <path-to-lmdb-store>
+
+guix shell python-click python-lmdb python-wrapper python-numpy -- \
+     python lmdb_matrix.py print-current-matrix \
+     <path-to-lmdb-store>
+
+"""
 import os
 import lmdb
 import json