nltts_diff: Calculates the nLTT statistic between each phylogeny in a...

Description Usage Arguments Value Author(s) See Also Examples

View source: R/nLTTDiff.R

Description

Calculates the nLTT statistic between each phylogeny in a collection compared to a same focal/reference tree

Usage

1
2
nltts_diff(tree, trees, distance_method = "abs", ignore_stem = TRUE,
  log_transform = FALSE)

Arguments

tree

One phylogenetic tree

trees

A collection of one or more phylogenetic trees

distance_method

(string) absolute, or squared distance?

ignore_stem

(logical) Should the phylogeny its stem be ignored?

log_transform

(logical) Should the number of lineages be log-transformed before normalization?

Value

the nLTT statistic values, as a numeric vector of the same length as trees

Author(s)

Richel J.C. Bilderbeek

See Also

use nltt_diff to compare two phylogenies

Examples

1
2
3
4
  tree <- ape::rcoal(4)
  trees <- c(ape::rcoal(4), ape::rcoal(4))
  nltts <- nltts_diff(tree, trees)
  testit::assert(all(nltts >= 0.0 && nltts <= 1.0))

nLTT documentation built on Jan. 13, 2020, 9:06 a.m.