pick_grove: Pick a grove in the case of multiple groves in a set of...

View source: R/groves.R

pick_groveR Documentation

Pick a grove in the case of multiple groves in a set of trees.

Description

Pick a grove in the case of multiple groves in a set of trees.

Usage

pick_grove(grove_list, criterion = "taxa", datelife_result)

Arguments

grove_list

A list of vectors of tree indices. Each element is a grove.

criterion

Defaults to criterion = "taxa". Used for chronogram summarizing, i.e., obtaining a single summary chronogram from a group of input chronograms. For summarizing approaches that return a single summary tree from a group of phylogenetic trees, it is necessary that the latter form a grove, roughly, a sufficiently overlapping set of taxa between trees, see Ané et al. (2009) \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1007/s00026-009-0017-x")}. In rare cases, a group of trees can have multiple groves. This argument indicates whether to get the grove with the most trees (criterion = "trees") or the most taxa (criterion = "taxa").

datelife_result

A datelifeResult object. Only needed for criterion = "taxa".

Value

A numeric vector of the elements of the picked grove.


phylotastic/datelife documentation built on Jan. 17, 2024, 11:10 p.m.