Skip to content

Make a randomly generated phylogenetic tree

A randomly generated phylogenetic tree can be made using random_tree. Multiple tree generation modes are supported with the TreeGenMode including balanced, birth-death, caterpillar, star, uniform, and Yule-Harding tree.

Usage

Basic Usage

Specify the number of taxa, and under what method the tree is to be generated. See the documentation for TreeGenMode for all available generation options.

Note: if star trees are generated the tree appears bifurcating, but branch lengths are set to zero where appropriate.

from piqtree import TreeGenMode, random_tree

num_taxa = 100

tree = random_tree(num_taxa, TreeGenMode.YULE_HARDING)

Reproducible Results

For reproducible results, a random seed may be specified.

Caution: 0 is a specific random seed. None is equivalent to no random seed being specified.

from piqtree import TreeGenMode, random_tree

num_taxa = 100

tree = random_tree(num_taxa, TreeGenMode.CATERPILLAR, rand_seed=1)

See also