Summary Statistic: Ancestral Trees

Share:

Description

This statistic returns ancestral tress in NEWICK format.

Usage

1
sumstat_trees(name = "trees")

Arguments

name

The name of the summary statistic. When simulating a model, the value of the statistics are written to an entry of the returned list with this name. Summary statistic names must be unique in a model.

See Also

To create a demographic model: coal_model

To calculate this statistic from data: calc_sumstats_from_data

Other summary statistics: sumstat_dna, sumstat_file, sumstat_four_gamete, sumstat_ihh, sumstat_jsfs, sumstat_mcmf, sumstat_nucleotide_div, sumstat_omega, sumstat_seg_sites, sumstat_sfs, sumstat_tajimas_d

Examples

1
2
3
4
5
6
7
8
9
# Without recombination:
model <- coal_model(4, 2) + sumstat_trees()
stats <- simulate(model)
print(stats$trees)

# With recombination:
model <- model + feat_recombination(5)
stats <- simulate(model)
print(stats$trees)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.