Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromekelleher authored and mergify[bot] committed Jul 13, 2023
1 parent bb28809 commit e20a0a2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
8 changes: 7 additions & 1 deletion python/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
4 changes: 2 additions & 2 deletions python/tskit/trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit e20a0a2

Please sign in to comment.