File: merger_models.rst

package info (click to toggle)
python-treetime 0.11.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 21,316 kB
  • sloc: python: 8,437; sh: 124; makefile: 49
file content (33 lines) | stat: -rw-r--r-- 1,133 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
******************************
Coalescent class documentation
******************************

.. Note::
    Using the coalescent model is optional. When running via the command line this class will only be initialized when
    the flag

    .. code-block:: bash

        --coalescent <arg>

    is used.
    The argument is either ``‘const’`` (have TreeTime estimate a constant coalescence rate), or ``‘skyline’`` (estimate a piece-wise linear merger rate trajectory)
    or a floating point number giving the time scale of coalescence in units of divergence (``Tc``). This is also
    called the effective population size.

.. autoclass::  treetime.Coalescent
    :members: __init__

Parameters of the Kingsman coalescence model
--------------------------------------------

.. automethod:: treetime.Coalescent.branch_merger_rate
.. automethod:: treetime.Coalescent.total_merger_rate
.. automethod:: treetime.Coalescent.cost

Skyline Methods
---------------------

.. automethod:: treetime.Coalescent.optimize_skyline
.. automethod:: treetime.Coalescent.skyline_empirical
.. automethod:: treetime.Coalescent.skyline_inferred