Skip to content

Commit a963898

Browse files
committed
Add note about validity of node times & tsdate
1 parent 5e47c57 commit a963898

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ The algorithm, its rationale, and results from testing on simulated and real dat
1313
1414
Please cite this if you use ``tsinfer`` in your work. Code to reproduce the results in the paper is present in a [separate GitHub repository](https://github.com/mcveanlab/treeseq-inference).
1515

16+
Note that `tsinfer` does not attempt to infer node times (i.e. branch lengths of the
17+
inferred trees). If you require a tree sequence where the dates of common ancestors
18+
are expressed in calendar or generation times, you should post-process the ``tsinfer``
19+
output using software such as [``tsdate``](https://github.com/tskit-dev/tsdate).

docs/introduction.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,13 @@ The output of ``tsinfer`` is a :class:`tskit.TreeSequence` and so the
2020
full `tskit API <https://tskit.readthedocs.io>`_ can be used to
2121
analyse real data, in precisely the same way that it is commonly used
2222
to analyse simulation data, for example, from `msprime <https://msprime.readthedocs.io/>`_.
23+
24+
.. note::
25+
26+
``Tsinfer`` infers the genetic relationships between sampled genomes, but does not
27+
attempt to infer the *times* of most recent common ancestors (tMRCAs) in the genealogy.
28+
If you are using the output of ``tsinfer`` in downstream analysis that relies on
29+
node times, you are advised not to use the inferred tree sequences directly; instead,
30+
you should post-process the ``tsinfer`` output using software such as
31+
`tsdate <https://tsdate.readthedocs.io>`_ that attempts to assign calendar or
32+
generation times to the tree sequence nodes.

0 commit comments

Comments
 (0)