Clarify doc

szhan · Sep 20, 2023 · ccf971a · ccf971a
1 parent 12e2072
commit ccf971a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/python/tests/beagle.py b/python/tests/beagle.py
@@ -48,7 +48,8 @@ def convert_to_genetic_map_position(pos):
     """
     Convert genomic site positions (bp) to genetic map positions (cM).
 
-    In BEAGLE 4.1, when a genetic map is not specified, it is assumed that 1 Mbp = 1cM.
+    In BEAGLE 4.1, when a genetic map is not specified, it is assumed
+    that the recombination rate is constant (1 cM / 1 Mb).
 
     This trivial function is meant for documentation.
 
@@ -57,7 +58,7 @@ def convert_to_genetic_map_position(pos):
     :rtype: numpy.ndarray
     """
     assert 0 < np.min(pos), "Site positions are not 1-based or invalid."
-    return pos / 1e6
+    return pos / 1e6  # Convert to Mb
 
 
 def get_weights(genotyped_pos, ungenotyped_pos):

diff --git a/python/tests/beagle_numba.py b/python/tests/beagle_numba.py
@@ -14,15 +14,16 @@ def convert_to_genetic_map_position(pos):
     """
     Convert genomic site positions (bp) to genetic map positions (cM).
 
-    In BEAGLE 4.1, when a genetic map is not specified, it is assumed that 1 Mbp = 1cM.
+    In BEAGLE 4.1, when a genetic map is not specified, it is assumed
+    that the recombination rate is constant (1 cM / 1 Mb).
 
     This trivial function is meant for documentation.
 
     :param numpy.ndarray pos: Site positions.
     :return: Genetic map positions.
     :rtype: numpy.ndarray
     """
-    return pos / 1e6
+    return pos / 1e6  # Convert to Mb
 
 
 @njit