@@ -247,9 +247,10 @@ def get_cumulative_mass(self, x=None):
247
247
given point for a list of positions along the map. This is equal to
248
248
the integral of the rate from 0 to the point.
249
249
250
- .. note:: If the RateMap is a "genetic map" (that is, it measures the
251
- rate of recombination along the genome), this function will return
252
- the "genetic distance" along the chromosome, e.g. in Morgans
250
+ .. note:: If the RateMap is a "genetic map" measuring the
251
+ rate of recombination along a chromosome, this function will return
252
+ the "genetic distance" (i.e. the map distance) for the provided
253
+ physical positions e.g. in Morgans.
253
254
254
255
:param numpy.ndarray x: The positions for which to return values. If None,
255
256
get the cumulative mass at each :attr:`~.RateMap.position` used
@@ -527,7 +528,8 @@ def read_hapmap(
527
528
physical position in the file is marked as unknown. Otherwise, act
528
529
as if an additional row, specifying physical position 0 and genetic
529
530
position 0, exists at the start of the file.
530
- :return: A RateMap object.
531
+ :return: A RateMap object, whose :meth:`get_cumulative_mass` method can
532
+ be used to translate physical positions into positions in the genetic map.
531
533
:rtype: RateMap
532
534
"""
533
535
# fmt: on
0 commit comments