Skip to content

CompEvol/sampled-ancestors

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

309 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sampled Ancestors

CI & Publish

This BEAST 3 package provides MCMC proposals and post-processing tools for samples of trees containing sampled ancestors. It relies on the support for sampled-ancestor trees built into the beast.base.evolution.tree.Tree class.

Single Maven artifact: io.github.compevol:sampled-ancestors. JPMS module: sampled.ancestors.

The paper describing this package is:

Alexandra Gavryushkina, David Welch, Tanja Stadler, Alexei J. Drummond (2014) Bayesian Inference of Sampled Ancestor Trees for Epidemiology and Fossil Calibration. PLoS Computational Biology https://doi.org/10.1371/journal.pcbi.1003919

Building from source

Requirements:

  • JDK 25 or later
  • Apache Maven
mvn compile

To run an example:

mvn exec:exec -Dbeast.args="examples/bears.xml"

To launch BEAUti:

mvn exec:exec -Dbeast.module=beast.fx -Dbeast.main=beastfx.app.beauti.Beauti

Project structure

sa.app.simulators

Simulators for the fossilized birth-death (FBD) model and FBD-skyline model.

sa.app.tools

Conversion tools between zero-branch-length sampled-ancestor trees and native sampled-ancestor trees.

sa.app.tools.fx

SATreeTraceAnalysis and various other post-processing tools.

sa.evolution.operators

Operators that permit MCMC on sampled-ancestor trees.

sa.evolution.speciation

SpeciesTreeDistribution calculations for the FBD prior:

  • SABirthDeathModel -- FBD prior with multiple hard-coded parameterizations
  • ParameterizedSABirthDeathModel -- FBD prior with object-oriented parameterizations

sa.beauti

BEAUti input editors for sampled-ancestor priors.

fxtemplates

Contains FBD.xml, a BEAUti template for SABirthDeathModel and sampled-ancestor tree operators. Located at src/main/resources/sampled.ancestors/fxtemplates/.

License

This software is free (as in freedom). With your modified versions provided you extend the same courtesy to users of your modified version. Specifically, it is made available under the terms of the GNU General Public License version 3.

Acknowledgements

Work on this project was supported by:

About

This BEAST2 package provides MCMC proposals and post-processing tools for sampling trees containing sampled ancestors

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors