From 9e1557ca95fec3b098c8f161b152b5e2073c8ca8 Mon Sep 17 00:00:00 2001 From: Jerome Kelleher Date: Thu, 13 Jul 2023 09:37:34 +0100 Subject: [PATCH] fix docs --- python/CHANGELOG.rst | 8 +++++++- python/tskit/trees.py | 4 ++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/python/CHANGELOG.rst b/python/CHANGELOG.rst index 94ad670759..f529d930d4 100644 --- a/python/CHANGELOG.rst +++ b/python/CHANGELOG.rst @@ -4,7 +4,13 @@ **Features** -- Add ``TreeSequence.impute_unknown_mutations_time`` method to return an array of mutation times based on the times of associated nodes (:user:`duncanMR`, :pr:`2760`, :issue:`2758`) +- Add ``TreeSequence.genetic_relatedness_weighted`` stats method. + (:user:`petrelharp`, :user:`brieuclehmann`, :user:`jeromekelleher`, + :pr:`2785`, :pr:`1246`) + +- Add ``TreeSequence.impute_unknown_mutations_time`` method to return an + array of mutation times based on the times of associated nodes + (:user:`duncanMR`, :pr:`2760`, :issue:`2758`) - Add ``asdict`` to all dataclasses. These are returned when you access a row or other tree sequence object. (:user:`benjeffery`, :pr:`2759`, :issue:`2719`) diff --git a/python/tskit/trees.py b/python/tskit/trees.py index 67b4db68aa..236a45b8b7 100644 --- a/python/tskit/trees.py +++ b/python/tskit/trees.py @@ -7996,12 +7996,12 @@ def genetic_relatedness_weighted( polarised=False, ): r""" - Computes weighted genetic relatedness: if the k-th pair of indices is (i, j) + Computes weighted genetic relatedness. If the k-th pair of indices is (i, j) then the k-th column of output will be :math:`\sum_{a,b} W_{ai} W_{bj} C_{ab}`, where :math:`W` is the matrix of weights, and :math:`C_{ab}` is the :meth:`genetic_relatedness <.TreeSequence.genetic_relatedness>` between sample - a and sample b, summing over all pairs of samples in the tree sequence. + a and sample b, summing over all pairs of samples in the tree sequence. :param numpy.ndarray W: An array of values with one row for each sample node and one column for each set of weights.