Learn R Programming

TransPhylo

Introduction

This is the homepage of TransPhylo, a software package that can reconstruct infectious disease transmission using genomic data. The input is a dated phylogeny, where leaves correspond to pathogens sampled from the known infected hosts. The main output is a transmission tree which indicates who infected whom, including the potential existence of unsampled individuals who may have acted as missing transmission links. TransPhylo works by colouring the branches of the phylogeny using a separate colour for each host, sampled or not. Each section of the tree coloured in a unique colour represents the pathogen evolution happening within a distinct host. Changes of colours on branches therefore correspond to transmission events from one host to another.

For example, in the tree below, the outbreak started with the unsampled host 8, who transmitted to sampled host 4, who transmitted to unsampled host 3, who transmitted to both sampled hosts 1 and 2. Host 8 also transmitted to unsampled host 7 who transmitted to both sampled hosts 5 and 6 .

For a more formal description of TransPhylo, see the following paper:

Didelot, Fraser, Gardy and Colijn (2017) Genomic infectious disease epidemiology in partially sampled and ongoing outbreaks Molecular Biology and Evolution, 34:997-1007 https://academic.oup.com/mbe/article/34/4/997/2919386

Installation

You can install TransPhylo in R using the following command:

devtools::install_github('xavierdidelot/TransPhylo')

Documentation

See the TransPhylo tutorial at https://xavierdidelot.github.io/TransPhylo/articles/TransPhylo.html. This tutorial is also available within the R package as a vignette. The TransPhylo reference manual is available at https://xavierdidelot.github.io/TransPhylo/reference/index.html.

Getting help

If you need assistance using TransPhylo, you can get in touch by emailing xavier.didelot@gmail.com

TransPhyloMatlab

If you are looking for the older Matlab version of TransPhylo described in Didelot et al (2014) Molecular Biology and Evolution 31:1869-1879, please note that this has now been moved to the repository TransPhyloMatlab, available at https://github.com/xavierdidelot/TransPhyloMatlab

Copy Link

Version

Install

install.packages('TransPhylo')

Monthly Downloads

80

Version

1.4.5

License

GPL (>= 2)

Maintainer

Xavier Didelot

Last Published

April 20th, 2021

Functions in TransPhylo (1.4.5)

extractPTree

Extracts phylogenetic tree from a combined phylogenetic/transmission tree
makeTTree

Simulate a transmission tree
getGenerationTimeDist

Extract and return realised generation time distribution
computeMatTDist

Build a matrix indicating for each pairs of individuals how many intermediates there are in the transmission chain
computeMatWIW

Build a matrix of probability of who infected whom from a MCMC output
getInfectionTimeDist

Extract and return distribution of infection time of given sampled case(s)
phyloFromPTree

Converts a phylogenetic tree into an ape phylo object
medTTree

Return the medoid from a MCMC output
plot.ttree

Plotting for ttree
getOffspringDist

Extract and return offspring distribution of given sampled case(s)
plot.ctree

Plotting for ctree
TransPhylo-package

Inference of Transmission Tree from a Dated Phylogeny
getIncidentCases

Returns and/or plot numbers of sampled and unsampled cases over time
print.resTransPhylo

Print function for resTransPhylo objects
print.ptree

Print function for ptree objects
as.mcmc.resTransPhylo

Convert to coda mcmc format
infer_multittree_share_param

Simultaneously infer transmission trees given phylogenetic trees User can specify any subset of parameters that will be shared by providing a character vector of parameter names to the argument "share".
plotCTree

Plot both phylogenetic and transmission trees using colors on the phylogeny
dateLastSample

Return the date of last sample from a ttree or ctree or ptree
getSamplingTimeDist

Extract and return realised sampling time distribution
selectTTree

Select the most representative transmission tree from a MCMC output
makeCTreeFromPTree

Create a transmission tree compatible with the provided phylogenetic tree
extractCTree

Return the combined tree corresponding to a given iteration of the TransPhylo results
inferTTree

Infer transmission tree given a phylogenetic tree
plotTTree

Plot a transmission tree in a detailed format
plotTTree2

Plot a transmission tree in an economic format
print.ttree

Print function for ttree objects
probPTreeGivenTTree

Calculate the probability of a phylogenetic tree given a transmission tree
plot.ptree

Plotting for ptree
consTTree

Build a consensus transmission tree from a MCMC output
probTTreeR

Calculates the log-probability of a transmission tree
ptreeFromPhylo

Converts an ape phylo object into a phylogenetic tree
convertToCoda

Convert to coda mcmc format
print.ctree

Print function for ctree objects
plotTraces

Plot MCMC traces
probPTreeGivenTTreeR

Calculate the probability of a phylogenetic tree given a transmission tree
probTTree

Calculates the log-probability of a transmission tree
plot.resTransPhylo

Plotting for resTransPhylo
summary.resTransPhylo

Summary function for resTransPhylo objects
simulateOutbreak

Simulate an outbreak
extractTTree

Extracts transmission tree from a combined phylogenetic/transmission tree