Skip to content

Commit

Permalink
Add note re deleting only the mutations
Browse files Browse the repository at this point in the history
  • Loading branch information
hyanwong authored and mergify[bot] committed Dec 4, 2024
1 parent 9dcae00 commit d1d5bb7
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions python/tskit/trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -6821,6 +6821,10 @@ def delete_sites(self, site_ids, record_provenance=True):
effect (i.e., calling ``tree_sequence.delete_sites([0, 1, 1])`` has the same
effect as calling ``tree_sequence.delete_sites([0, 1])``.
.. note::
To remove only the mutations associated with a site, but keep the site
itself, use the :meth:`MutationTable.keep_rows` method.
:param list[int] site_ids: A list of site IDs specifying the sites to remove.
:param bool record_provenance: If ``True``, add details of this operation to the
provenance information of the returned tree sequence. (Default: ``True``).
Expand Down

0 comments on commit d1d5bb7

Please sign in to comment.