Skip to content

Commit b7fd993

Browse files
petrelharphyanwong
authored andcommitted
remaining edits from #3359
1 parent f6bc49e commit b7fd993

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

python/tskit/trees.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9304,17 +9304,17 @@ def pca(
93049304
randomized singular value decomposition (rSVD) algorithm.
93059305
93069306
Concretely, take :math:`M` as the matrix of non-span-normalised
9307-
branch-based genetic relatedness values, for instance obtained by
9307+
genetic relatedness values, for instance obtained by
93089308
setting :math:`M_{ij}` to be the :meth:`~.TreeSequence.genetic_relatedness`
9309-
between sample :math:`i` and sample :math:`j` with ``mode="branch"``,
9309+
between sample :math:`i` and sample :math:`j` with the specified ``mode``,
93109310
``proportion=False`` and ``span_normalise=False``. Then by default this
93119311
returns the top ``num_components`` eigenvectors of :math:`M`, so that
93129312
``output.factors[i,k]`` is the position of sample `i` on the `k` th PC.
93139313
If ``samples`` or ``individuals`` are provided, then this does the same
93149314
thing, except with :math:`M_{ij}` either the relatedness between
93159315
``samples[i]`` and ``samples[j]`` or the average relatedness between the
93169316
nodes of ``individuals[i]`` and ``individuals[j]``, respectively.
9317-
Factors are normalized to have L2 norm 1, i.e.,
9317+
Factors are normalized to have norm 1, i.e.,
93189318
``output.factors[:,k] ** 2).sum() == 1)`` for any ``k``.
93199319
93209320
The parameters ``centre`` and ``mode`` are passed to

0 commit comments

Comments
 (0)