rates_from_dd_model: Get speciation and extinction rates values given a DD model...

View source: R/rates_from_dd_model.R

rates_from_dd_modelR Documentation

Get speciation and extinction rates values given a DD model and parameters

Description

Get speciation and extinction rates values given a DD model and parameters

Usage

rates_from_dd_model(N_seq, dd_model, params)

Arguments

N_seq

numeric vector, the values for which rate values are desired

dd_model

a list with five named elements that together specify the diversity-dependent model:

  • name a two-letter code, the name of the model. First letter specifies the form of the speciation function, second letter the form of the extinction function: "l" for "linear", "x" for exponential, "c" for constant.

  • speciation_func, a function specifying the diversity-dependent speciation rate. Must take arguments params and N.

  • extinction_func, a function specifying the diversity-dependent extinction rate. Must take arguments params and N.

  • constraints a list of conditions that parameter values must satisfy. Each element is a function that takes arguments params and ..., and returns TRUE if the constraint is satisfied, FALSE if it isn't.

  • params_check a function that controls the format of params. Returns an error if the elements of params are named differently from what is expected or if the length differs from the expectation.

comrad contains several dd_model functions, see for example dd_model_lc().

params

a named vector containing the values of the parameters of speciation_func and extinction_func.

Value

a tibble with variables N, rate (speciation or extinction), value (value of that rate), and dd_model (name of the DD model)

Author(s)

Théo Pannetier


TheoPannetier/comrad documentation built on April 8, 2023, 8:06 a.m.