Skip to content

Add doc note re: mutations per site #3184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeromekelleher merged 1 commit into from
May 30, 2025
Merged

Add doc note re: mutations per site #3184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions python/tskit/trees.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5972,6 +5972,10 @@ def mutations_site(self):
:ref:`sec_mutation_table_definition` as a numpy array (dtype=np.int32).
Equivalent to ``ts.tables.mutations.site`` (but avoiding the full copy
of the table data that accessing ``ts.tables`` currently entails).

.. note::
To efficently get an array of the number of mutations per site, you
can use ``np.bincount(ts.mutations_site, minlength=ts.num_sites)``.
"""
return self._mutations_site

Expand Down
Loading