check_event_times: Check if a 'event_times' is valid.

View source: R/check_event_times.R

check_event_timesR Documentation

Check if a event_times is valid.

Description

Check if a event_times is valid. Will stop if not

Usage

check_event_times(event_times)

Arguments

event_times

the island age, stem age of species, and -for cladogenetic species- speciation times, as checked by check_event_times

Details

event_times contains:

  • for cladogenetic species: the island age and event 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 event_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_event_times(1.0)
check_event_times(c(1.0, 0.25))

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