Skip to content
Commits on Source (6)
Show whitespace changes
Inline Side-by-side
.readthedocs.yml 0 → 100644
View file @ 83e54bb9
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
# Optionally build your docs in additional formats such as PDF and ePub
formats: all
# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/requirements.txt
- method: pip
path: .
.travis.yml
View file @ 83e54bb9
......@@ -4,7 +4,6 @@ python:
- "3.5"
- "2.7"
install:
- sudo apt-get update
- wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
- bash miniconda.sh -b -p $HOME/miniconda
- export PATH="$HOME/miniconda/bin:$PATH"
......@@ -14,7 +13,7 @@ install:
# Useful for debugging any issues with conda
- conda info -a
- conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION numpy scipy biopython nose
- conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION numpy scipy biopython pandas matplotlib nose
- source activate test-environment
- python setup.py install
script:
......
README.md
View file @ 83e54bb9
[![Build Status](https://travis-ci.org/neherlab/treetime.svg?branch=master)](https://travis-ci.org/neherlab/treetime)
[![anaconda](https://anaconda.org/bioconda/treetime/badges/installer/conda.svg)](https://anaconda.org/bioconda/treetime)
[![readthedocs](https://readthedocs.org/projects/treetime/badge/)](https://treetime.readthedocs.io/en/latest/)
## TreeTime: maximum likelihood dating and ancestral sequence inference
### Overview
......@@ -10,6 +12,7 @@ TreeTime provides routines for ancestral sequence reconstruction and inference o
To optimize the likelihood of time-scaled phylogenies, TreeTime uses an iterative approach that first infers ancestral sequences given the branch length of the tree, then optimizes the positions of unconstrained nodes on the time axis, and then repeats this cycle.
The only topology optimization are (optional) resolution of polytomies in a way that is most (approximately) consistent with the sampling time constraints on the tree.
The package is designed to be used as a stand-alone tool on the command-line or as a library used in larger phylogenetic analysis work-flows.
[The documentation of TreeTime is hosted on readthedocs.org](https://treetime.readthedocs.io/en/latest/).
In addition to scripting TreeTime or using it via the command-line, there is also a small web server at [treetime.ch](https://treetime.biozentrum.unibas.ch/).
......@@ -23,6 +26,7 @@ Have a look at our [examples and tutorials](https://github.com/neherlab/treetime
* inference of GTR models
* rerooting to maximize temporal signal and optimize the root-to-tip distance vs time relationship
* simple phylodynamic analysis such as coalescent model fits
* sequence evolution along trees using flexible site specific models.
## Table of contents
* [Installation and prerequisites](#installation-and-prerequisites)
......
bin/treetime
View file @ 83e54bb9
#!/usr/bin/env python
from __future__ import print_function, division, absolute_import
import sys, argparse, os
from treetime import version
from treetime.wrappers import ancestral_reconstruction, mugration, scan_homoplasies, timetree, estimate_clock_model
import sys
from treetime import version, make_parser
import matplotlib
matplotlib.use('AGG')
py2 = sys.version_info.major==2
def set_default_subparser(self, name, args=None, positional_args=0):
"""default subparser selection. Call after setup, just before parse_args()
name: is the name of the subparser to call by default
args: if set is the argument list handed to parse_args()
https://stackoverflow.com/questions/6365601/default-sub-command-or-handling-no-sub-command-with-argparse
"""
subparser_found = False
if len(sys.argv)==1:
sys.argv.append('-h')
else:
for x in self._subparsers._actions:
if not isinstance(x, argparse._SubParsersAction):
continue
for sp_name in x._name_parser_map.keys():
if sp_name in sys.argv[1:]:
subparser_found = True
if not subparser_found:
# insert default subcommand in first position
if args is None:
sys.argv.insert(1, name)
else:
args.insert(1, name)
if py2:
argparse.ArgumentParser.set_default_subparser = set_default_subparser
treetime_description = \
"TreeTime: Maximum Likelihood Phylodynamics\n\n"
subcommand_description = \
"In addition, TreeTime implements several sub-commands:\n\n"\
"\t ancestral\tinfer ancestral sequences maximizing the joint or marginal likelihood.\n"\
"\t homoplasy\tanalyze patterns of recurrent mutations aka homoplasies.\n"\
"\t clock\t\testimate molecular clock parameters and reroot the tree.\n"\
"\t mugration\tmap discrete character such as host or country to the tree.\n\n"\
"(note that 'tt' is a default subcommand in python2 that doesn't need to be specified).\n"\
"To print a description and argument list of the individual sub-commands, type:\n\n"\
"\t treetime <subcommand> -h\n\n"
ref_msg = \
"If you use results from treetime in a publication, please cite:"\
"\n\n\tSagulenko et al. TreeTime: Maximum-likelihood phylodynamic analysis"\
"\n\tVirus Evolution, vol 4, https://academic.oup.com/ve/article/4/1/vex042/4794731\n"
timetree_description=\
"TreeTime infers a time scaled phylogeny given a tree topology, an alignment, "\
"and tip dates. Reconstructs ancestral sequences and infers a molecular clock tree. "\
"TreeTime will reroot the tree and resolve polytomies by default. "\
"In addition, treetime will infer ancestral sequences and a GTR substitution model. "\
"Inferred mutations are included as comments in the output tree.\n\n"
gtr_description = "GTR model to use. '--gtr infer' will infer a model "\
"from the data. Alternatively, specify the model type. If the specified model "\
"requires additional options, use '--gtr-params' to specify those."
gtr_params_description = "GTR parameters for the model specified by "\
"the --gtr argument. The parameters should be feed as 'key=value' "\
"list of parameters. Example: '--gtr K80 --gtr-params kappa=0.2 "\
"pis=0.25,0.25,0.25,0.25'. See the exact definitions of the "\
"parameters in the GTR creation methods in treetime/nuc_models.py "\
"or treetime/aa_models.py"
reroot_description = "reroot the tree. Valid choices are "\
"'ML', 'ML-rough', 'least-squares', 'min_dev', 'midpoint' or a node name "\
" to be used as outgroup. Use --keep-root to keep the current root."
tree_description = "Name of file containing the tree in "\
"newick, nexus, or phylip format. If none is provided, "\
"treetime will attempt to build a tree from the alignment "\
"using fasttree, iqtree, or raxml (assuming they are installed)"
aln_description = "alignment file (fasta)"
dates_description = "csv file with dates for nodes with 'node_name, date' where date is float (as in 2012.15)"
coalescent_description = \
"coalescent time scale -- sensible values are on the order of the average "\
"hamming distance of contemporaneous sequences. In addition, 'opt' "\
"'skyline' are valid options and estimate a constant coalescent rate "\
"or a piecewise linear coalescent rate history"
ancestral_description = \
"Reconstructs ancestral sequences and maps mutations to the tree. "\
"The output consists of a file 'ancestral.fasta' with ancestral sequences "\
"and a tree 'annotated_tree.nexus' with mutations added as comments "\
"like A45G,G136T,..., number in SNPs used 1-based index by default. "\
"The inferred GTR model is written to stdout."
homoplasy_description = \
"Reconstructs ancestral sequences and maps mutations to the tree. "\
"The tree is then scanned for homoplasies. An excess number of homoplasies "\
"might suggest contamination, recombination, culture adaptation or similar."
mugration_description = \
"Reconstructs discrete ancestral states, for example "\
"geographic location, host, or similar. In addition to ancestral states, "\
"a GTR model of state transitions is inferred."
def add_seq_len_aln_group(parser):
parser.add_argument('--sequence-length', type=int, help="length of the sequence, "
"used to calculate expected variation in branch length. "
"Not required if alignment is provided.")
add_aln_group(parser, required=False)
# seq_group_ex.add_argument('--aln', type=str, help=aln_description)
def add_aln_group(parser, required=True):
parser.add_argument('--aln', required=required, type=str, help=aln_description)
parser.add_argument('--vcf-reference', type=str, help='only for vcf input: fasta file of the sequence the VCF was mapped to.')
def add_reroot_group(parser):
parser.add_argument('--clock-filter', type=float, default=3,
help="ignore tips that don't follow a loose clock, "
"'clock-filter=number of interquartile ranges from regression'")
reroot_group = parser.add_mutually_exclusive_group()
reroot_group.add_argument('--reroot', type=str, default='best', help=reroot_description)
reroot_group.add_argument('--keep-root', required = False, action="store_true", default=False,
help ="don't reroot the tree. Otherwise, reroot to minimize the "
"the residual of the regression of root-to-tip distance and sampling time")
def add_gtr_arguments(parser):
parser.add_argument('--gtr', default='infer', help=gtr_description)
parser.add_argument('--gtr-params', nargs='+', help=gtr_params_description)
parser.add_argument('--aa', action='store_true', help="use aminoacid alphabet")
def add_anc_arguments(parser):
parser.add_argument('--keep-overhangs', default = False, action='store_true', help='do not fill terminal gaps')
parser.add_argument('--zero-based', default = False, action='store_true', help='zero based mutation indexing')
parser.add_argument('--report-ambiguous', default=False, action="store_true", help='include transitions involving ambiguous states')
def add_common_args(parser):
parser.add_argument('--verbose', default=1, type=int, help='verbosity of output 0-6')
parser.add_argument('--outdir', type=str, help='directory to write the output to')
if __name__ == '__main__':
## TIMETREE
parser = argparse.ArgumentParser(description = "",
usage=treetime_description)
subparsers = parser.add_subparsers()
if py2:
t_parser = subparsers.add_parser('tt', description=timetree_description)
else:
t_parser = parser
t_parser.add_argument('--tree', type=str, help=tree_description)
add_seq_len_aln_group(t_parser)
t_parser.add_argument('--dates', type=str, help=dates_description)
add_reroot_group(t_parser)
add_gtr_arguments(t_parser)
t_parser.add_argument('--clock-rate', type=float, help="if specified, the rate of the molecular clock won't be optimized.")
t_parser.add_argument('--clock-std-dev', type=float, help="standard deviation of the provided clock rate estimate")
t_parser.add_argument('--branch-length-mode', default='auto', type=str, choices=['auto', 'input', 'joint', 'marginal'],
help="If set to 'input', the provided branch length will be used without modification. "
"Note that branch lengths optimized by treetime are only accurate at short evolutionary distances.")
t_parser.add_argument('--confidence', action='store_true', help="estimate confidence intervals of divergence times.")
t_parser.add_argument('--keep-polytomies', default=False, action='store_true',
help="Don't resolve polytomies using temporal information.")
t_parser.add_argument('--relax',nargs=2, type=float,
help='use an autocorrelated molecular clock. Strength of the gaussian priors on'
' branch specific rate deviation and the coupling of parent and offspring'
' rates can be specified e.g. as --relax 1.0 0.5. Values around 1.0 correspond'
' to weak priors, larger values constrain rate deviations more strongly.'
' Coupling 0 (--relax 1.0 0) corresponds to an un-correlated clock.')
t_parser.add_argument('--max-iter', default=2, type=int,
help='maximal number of iterations the inference cycle is run. Note that for polytomy resolution and coalescence models max_iter should be at least 2')
t_parser.add_argument('--coalescent', default="0.0", type=str,
help=coalescent_description)
t_parser.add_argument('--plot-tree', default="timetree.pdf",
help = "filename to save the plot to. Suffix will determine format"
" (choices pdf, png, svg, default=pdf)")
t_parser.add_argument('--plot-rtt', default="root_to_tip_regression.pdf",
help = "filename to save the plot to. Suffix will determine format"
" (choices pdf, png, svg, default=pdf)")
t_parser.add_argument('--tip-labels', action='store_true',
help = "add tip labels (default for small trees with <30 leaves)")
t_parser.add_argument('--no-tip-labels', action='store_true',
help = "don't show tip labels (default for small trees with >=30 leaves)")
add_anc_arguments(t_parser)
add_common_args(t_parser)
def toplevel(params):
if (params.aln or params.tree) and params.dates:
timetree(params)
else:
print(treetime_description+timetree_description+subcommand_description+
"'--dates' and '--aln' or '--tree' are REQUIRED inputs, type 'treetime -h' for a full list of arguments.\n")
t_parser.set_defaults(func=toplevel)
parser = make_parser()
## HOMOPLASY SCANNER
h_parser = subparsers.add_parser('homoplasy', description=homoplasy_description)
add_aln_group(h_parser)
h_parser.add_argument('--tree', type = str, help=tree_description)
h_parser.add_argument('--const', type = int, default=0, help ="number of constant sites not included in alignment")
h_parser.add_argument('--rescale', type = float, default=1.0, help ="rescale branch lengths")
h_parser.add_argument('--detailed', required = False, action="store_true", help ="generate a more detailed report")
add_gtr_arguments(h_parser)
h_parser.add_argument('--zero-based', default = False, action='store_true', help='zero based mutation indexing')
h_parser.add_argument('-n', default = 10, type=int, help='number of mutations/nodes that are printed to screen')
h_parser.add_argument('--drms', type=str, help='TSV file containing DRM info. columns headers: GENOMIC_POSITION, ALT_BASE, DRUG, GENE, SUBSTITUTION')
add_common_args(h_parser)
h_parser.set_defaults(func=scan_homoplasies)
## ANCESTRAL RECONSTRUCTION
a_parser = subparsers.add_parser('ancestral', description=ancestral_description)
add_aln_group(a_parser)
a_parser.add_argument('--tree', type = str, help =tree_description)
add_gtr_arguments(a_parser)
a_parser.add_argument('--marginal', default = False, action="store_true", help ="marginal reconstruction of ancestral sequences")
add_anc_arguments(a_parser)
add_common_args(a_parser)
a_parser.set_defaults(func=ancestral_reconstruction)
## MUGRATION
m_parser = subparsers.add_parser('mugration', description=mugration_description)
m_parser.add_argument('--tree', required = True, type=str, help=tree_description)
m_parser.add_argument('--attribute', type=str, help ="attribute to reconstruct, e.g. country")
m_parser.add_argument('--states', required = True, type=str, help ="csv or tsv file with discrete characters."
"\n#name,country,continent\ntaxon1,micronesia,oceania\n...")
m_parser.add_argument('--weights', type=str, help="csv or tsv file with probabilities of that a randomly sampled "
"sequence at equilibrium has a particular state. E.g. population of different continents or countries. E.g.:"
"\n#country,weight\nmicronesia,0.1\n...")
m_parser.add_argument('--confidence', action="store_true", help="output confidence of mugration inference")
m_parser.add_argument('--pc', type=float, default=1.0, help ="pseudo-counts higher numbers will results in 'flatter' models")
m_parser.add_argument('--missing-data', type=str, default='?', help ="string indicating missing data")
add_common_args(m_parser)
m_parser.set_defaults(func=mugration)
## CLOCKSIGNAL
c_parser = subparsers.add_parser('clock',
description="Calculates the root-to-tip regression and quantifies the 'clock-i-ness' of the tree. "
"It will reroot the tree to maximize the clock-like "
"signal and recalculate branch length unless run with --keep_root.")
c_parser.add_argument('--tree', required=True, type=str, help=tree_description)
c_parser.add_argument('--dates', required=True, type=str, help=dates_description)
add_seq_len_aln_group(c_parser)
add_reroot_group(c_parser)
c_parser.add_argument('--allow-negative-rate', required = False, action="store_true", default=False,
help="By default, rates are forced to be positive. For trees with little temporal "
"signal it is advisable to remove this restriction to achieve essentially mid-point rooting.")
c_parser.add_argument('--plot-rtt', default="root_to_tip_regression.pdf",
help = "filename to save the plot to. Suffix will determine format"
" (choices pdf, png, svg, default=pdf)")
add_common_args(c_parser)
c_parser.set_defaults(func=estimate_clock_model)
# make a version subcommand
v_parser = subparsers.add_parser('version', description='print version')
v_parser.set_defaults(func=lambda x: print(version))
## call the relevant function and return
if py2:
parser.set_default_subparser('tt')
params = parser.parse_args()
return_code = params.func(params)
sys.exit(return_code)
debian/changelog
View file @ 83e54bb9
python-treetime (0.6.2-1) unstable; urgency=medium
* New upstream version
* debhelper-compat 12
* Standards-Version: 4.4.0
-- Andreas Tille <tille@debian.org> Fri, 02 Aug 2019 19:53:16 +0200
python-treetime (0.5.3-1) unstable; urgency=medium
* New upstream version
......
debian/control
View file @ 83e54bb9
......@@ -4,7 +4,7 @@ Uploaders: Andreas Tille <tille@debian.org>
Section: science
Testsuite: autopkgtest-pkg-python
Priority: optional
Build-Depends: debhelper (>= 12~),
Build-Depends: debhelper-compat (= 12),
dh-python,
python3-all,
python3-biopython,
......@@ -12,7 +12,7 @@ Build-Depends: debhelper (>= 12~),
python3-pandas,
python3-scipy,
python3-setuptools
Standards-Version: 4.3.0
Standards-Version: 4.4.0
Vcs-Browser: https://salsa.debian.org/med-team/python-treetime
Vcs-Git: https://salsa.debian.org/med-team/python-treetime.git
Homepage: https://github.com/neherlab/treetime
......
doc/source/index.rst deleted 100644 → 0
View file @ a348b07e
.. TreeTime documentation master file, created by
sphinx-quickstart on Mon Jul 31 11:44:07 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
TreeTime documentation
====================================
TreeTime is organized as a hierarchy of classes. The GTR class implements sequence evolution models, TreeAnc does ancestral sequence reconstruction, ClockTree implements time tree inference for a fixed tree topology, while TreeTime provides convenient wrapper functions and additional functionality to manipulate the tree (e.g. rerooting and polytomy resolution).
.. toctree::
:maxdepth: 2
:hidden:
gtr
treeanc
clock_tree
treetime
vcf_utils
seq_utils
.. automodule:: treetime
:doc:`GTR class<gtr>`
---------------------
:doc:`TreeAnc class<treeanc>`
------------------------------
:doc:`ClockTree class<clock_tree>`
----------------------------------
:doc:`TreeTime class<treetime>`
-------------------------------
Utility code
============
:doc:`VCF tools<vcf_utils>`
-------------------------------
:doc:`Seq tools<seq_utils>`
-------------------------------
Command-line functions
======================
TreeTime is designed to be part of python workflows, but we have exposed a number of standard
tasks via a command-line interface.
The TreeTime command-line tool is called :code:`treetime`.
Examples and documentation of the command-line interface can be found in the github repo https://github.com/neherlab/treetime_examples.
In its standard mode, it will take a tree, an alignment, and file with dates as input and estimate a time-scaled phylogeny.
The full set of options are available via :code:`treetime -h`.
Subcommand :code:`treetime ancestral`
-------------------------------------
This subcommand reconstructs ancestral sequences and maps mutations to the tree.
It produces an alignment file containing inferred ancestral sequences and a tree file
with mutations included as comments. The inferred GTR model is written to stdout.
Subcommand :code:`treetime homoplasy`
-------------------------------------
Reconstructs ancestral sequences and maps mutations to the tree.
The tree is then scanned for homoplasies. An excess number of homoplasies
might suggest contamination, recombination, culture adaptation or similar.
Results are printed to stdout.
Subcommand :code:`treetime clock`
---------------
Calculates the root-to-tip regression and quantifies the 'clock-i-ness' of the tree.
It will reroot the tree to maximize the clock-like
signal and recalculate branch length unless run with :code:`--keep_root`.
Subcommand :code:`treetime mugration`
-------------------------------------
Reconstructs discrete ancestral states, for example geographic location, host, or similar.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs/requirements.txt 0 → 100644
View file @ 83e54bb9
recommonmark>=0.5.0
sphinx-argparse>=0.2.5
docs/source/APIdoc.rst 0 → 100644
View file @ 83e54bb9
API documentation
=================
.. toctree::
:maxdepth: 1
:hidden:
treetime
clock_tree
treeanc
seqgen
gtr
vcf_utils
seq_utils
Core classes
------------
.. automodule:: treetime
:doc:`TreeTime class<treetime>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:doc:`ClockTree class<clock_tree>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:doc:`TreeAnc class<treeanc>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:doc:`SeqGen class<seqgen>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~
:doc:`GTR class<gtr>`
~~~~~~~~~~~~~~~~~~~~~
Utility code
------------
:doc:`VCF tools<vcf_utils>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~
:doc:`Seq tools<seq_utils>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~
docs/source/commands.rst 0 → 100644
View file @ 83e54bb9
Detailed command line documentation
===================================
.. argparse::
:module: treetime
:func: make_parser
:prog: treetime
doc/source/conf.py → docs/source/conf.py
View file @ 83e54bb9
......@@ -14,7 +14,7 @@
import sys
import os
from treetime import version
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
......@@ -35,8 +35,9 @@ extensions = [
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinxjp.themes.basicstrap',
'sphinx.ext.napoleon',
'recommonmark',
'sphinxarg.ext'
]
# Napoleon settings
......@@ -59,7 +60,7 @@ templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ['.rst', '.md']
# The encoding of source files.
#source_encoding = 'utf-8-sig'
......@@ -69,17 +70,15 @@ master_doc = 'index'
# General information about the project.
project = u'TreeTime'
copyright = u'2017-2018, Pavel Sagulenko and Richard Neher'
copyright = u'2017-2019, Pavel Sagulenko and Richard Neher'
author = u'Pavel Sagulenko and Richard Neher'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'0.5.0'
# The full version, including alpha/beta/rc tags.
release = u'0.5.0'
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -133,16 +132,9 @@ todo_include_todos = True
# a list of builtin themes.
#html_theme = 'alabaster'
html_theme = 'basicstrap'
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'rightsidebar': True,
'sidebar_span': 3, # 1(min) - 12(max)
'content_fixed': True,
'content_width': '1200px',
'inner_theme': True,
'inner_theme_name': 'bootswatch-flatly',
}
html_theme_options = {}
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
......
docs/source/index.rst 0 → 100644
View file @ 83e54bb9
.. TreeTime documentation master file, created by
sphinx-quickstart on Mon Jul 31 11:44:07 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
TreeTime: time-tree and ancestral sequence inference
====================================================
.. image:: https://travis-ci.org/neherlab/treetime.svg?branch=master
:target: https://travis-ci.org/neherlab/treetime
.. image:: https://anaconda.org/bioconda/treetime/badges/installer/conda.svg
:target: https://anaconda.org/bioconda/treetime
TreeTime provides routines for ancestral sequence reconstruction and inference of molecular-clock phylogenies, i.e., a tree where all branches are scaled such that the positions of terminal nodes correspond to their sampling times and internal nodes are placed at the most likely time of divergence.
To optimize the likelihood of time-scaled phylogenies, TreeTime uses an iterative approach that first optimizes branch lengths of the tree given the sequence data and date constraints, and then optimizes coalescent tree priors, relaxed clock parameters, or resolves polytomies.
This cycle is repeated a few times.
The only topology optimization are (optional) resolution of polytomies in a way that is most (approximately) consistent with the sampling time constraints on the tree.
The code is hosted on `github.com/neherlab/treetime <https://github.com/neherlab/treetime>`_.
.. toctree::
:maxdepth: 2
:hidden:
installation
tutorials
commands
APIdoc
.. image:: https://raw.githubusercontent.com/neherlab/treetime_examples/master/figures/tree_and_clock.png
Features
--------
* ancestral sequence reconstruction (marginal and joint maximum likelihood)
* molecular clock tree inference (marginal and joint maximum likelihood)
* inference of GTR models
* rerooting to maximize temporal signal and optimize the root-to-tip distance vs time relationship
* simple phylodynamic analysis such as coalescent model fits
Developer info
--------------
- Source code on github at https://github.com/neherlab/treetime
- Copyright and License: Pavel Sagulenko, Emma Hodcroft, and Richard Neher, MIT Licence
- References
* `TreeTime: Maximum-likelihood phylodynamic analysis <https://academic.oup.com/ve/article/4/1/vex042/4794731>`_ by Pavel Sagulenko, Vadim Puller and Richard A Neher. Virus Evolution.
* `NextStrain: real-time tracking of pathogen evolution <https://academic.oup.com/bioinformatics/advance-article/doi/10.1093/bioinformatics/bty407/5001388>`_ by James Hadfield et al. Bioinformatics.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs/source/installation.rst 0 → 100644
View file @ 83e54bb9
Installation
============
TreeTime is compatible with Python 2.7 upwards and is tested on 2.7, 3.5, and 3.6. It depends on several Python libraries:
* numpy, scipy, pandas: for all kind of mathematical operations as matrix
operations, numerical integration, interpolation, minimization, etc.
* BioPython: for parsing multiple sequence alignments and phylogenetic trees
* matplotlib: optional dependency for plotting
Installing from PyPi or Conda
-----------------------------
You can also install TreeTime from PyPi via
.. code:: bash
pip install phylo-treetime
You might need root privileges for system wide installation.
Similarly, you can install from conda using
.. code:: bash
conda install -c bioconda treetime
Installing from source
----------------------
Clone or download the source code.
.. code:: bash
git clone https://github.com/neherlab/treetime.git
cd treetime
pip install .
You might need root privileges for system wide installation. Alternatively, you can simply use it TreeTime locally without installation. In this case, just download and unpack it, and then add the TreeTime folder to your $PYTHONPATH.
Building the documentation
--------------------------
The API documentation for the TreeTime package is generated created with Sphinx. The source code for the documentaiton is located in doc folder.
- sphinx-build to generate static html pages from source. Installed as
.. code:: bash
pip install Sphinx
- basicstrap Html theme for sphinx:
.. code:: bash
pip install recommonmark sphinx-argparse
After required packages are installed, navigate to doc directory, and build the docs by typing:
.. code:: bash
make html
Instead of html, another target as `latex` or `epub` can be specified to build the docs in the desired format.
docs/source/seqgen.rst 0 → 100644
View file @ 83e54bb9
Sequence evolution and generation
=================================
.. autoclass:: treetime.seqgen.SeqGen
:members: __init__