check_branching_times: Check if a 'branching_times' is valid.

View source: R/check_branching_times.R

check_branching_timesR Documentation

Check if a branching_times is valid.

Description

Check if a branching_times is valid. Will stop if not

Usage

check_branching_times(branching_times)

Arguments

branching_times

island age and stem age of the population/species in the case of Non-endemic, Non-endemic_MaxAge and Endemic anagenetic species.

For cladogenetic species these should be island age and branching times of the radiation including the stem age of the radiation.

See check_branching_times for a more detailed description.

Details

branching_times contains:

  • for cladogenetic species: the island age and branching times of the radiation, including the stem age of the radiation

  • for non-endemic, non-endemic_MaxAge and Endemic anagenetic species: island age and stem age of the population/species

A valid branching_times ...

  • is numeric

  • has only finite values

  • has at least 1 element (which equals the island age)

  • has only positive non-zero values (although zero is accepted, to prevent false negatives by rounding off errors)

  • has a descending order

Value

nothing

Author(s)

Richèl J.C. Bilderbeek

Examples

check_branching_times(1.0)
check_branching_times(c(1.0, 0.25))

joshwlambert/DAISIEmainland documentation built on July 14, 2024, 5:40 p.m.