Decapitate!

Closes #2236
tskit-dev · Jun 10, 2022 · 94a0354 · 94a0354
1 parent 830c9e7
commit 94a0354
Show file tree

Hide file tree

Showing 5 changed files with 586 additions and 13 deletions.
diff --git a/docs/python-api.md b/docs/python-api.md
@@ -219,6 +219,7 @@ which perform the same actions but modify the {class}`TableCollection` in place.
   TreeSequence.delete_sites
   TreeSequence.trim
   TreeSequence.split_edges
+  TreeSequence.decapitate
 ```
 
 (sec_python_api_tree_sequences_ibd)=
@@ -683,6 +684,7 @@ a functional way, returning a new tree sequence while leaving the original uncha
   TableCollection.delete_sites
   TableCollection.trim
   TableCollection.union
+  TableCollection.delete_older
 ```
 
 (sec_tables_api_creating_valid_tree_sequence)=

diff --git a/python/CHANGELOG.rst b/python/CHANGELOG.rst
@@ -30,6 +30,11 @@
   edges at a specific time.
   (:user:`jeromekelleher`, :issue:`2276`, :pr:`2296`).
 
+- Add the ``TreeSequence.decapitate`` (and closely related
+  ``TableCollection.delete_older``) operation to remove topology and mutations
+  older than a give time.
+  (:user:`jeromekelleher`, :issue:`2236`, :pr:`2302`, :pr:`2331`).
+
 - Add the ``TreeSequence.individuals_time`` and ``TreeSequence.individuals_population``
   methods to return arrays of per-individual times and populations, respectively.
   (:user:`petrelharp`, :issue:`1481`, :pr:`2298`).