setup_model: Set up DAISIE_ML arguments

In tece-lab/DAISIEutils: Utility Functions for the DAISIE Package

Set up DAISIE_ML arguments

Description

Set up DAISIE_ML arguments

Usage

setup_model(model, low_rates = FALSE, par_upper_bound = Inf)

Arguments

model	A string with model that should run. Models are as follows: "cr_dd" Clade specific model - diversity dependent. All parameters free. "cr_di" Clade specific model - diversity independent (K = Inf). All other parameters free. "cr_dd_0laa" Clade specific model - diversity dependent and no anagenesis (laa fixed to zero). All other parameters free. "cr_di_0laa" Clade specific model - diversity independent (K = Inf) and no anagenesis (laa fixed to zero). All other parameters free. "cr_di_0lac" Clade specific model - diversity indendent (K = Inf) and no cladogenesis (lac fixed to zero). All other parameters free. "cr_dd_0lac" Clade specific model - diversity dependent and no cladogenesis (lac fixed to zero). All other parameters free. "rr_lac_di" Clade specific model - diversity independent (K = Inf) and relaxed cladogenesis. All other parameters free. "rr_lac_dd" Clade specific model - diversity dependent and relaxed cladogenesis. All other parameters free. "rr_mu_di" Clade specific model - diversity independent (K = Inf) and relaxed extinction. All other parameters free. "rr_mu_dd" Clade specific model - diversity dependent and relaxed extinction. All other parameters free. "rr_k" Clade specific model - diversity dependent and relaxed carrying capacity. All other parameters free. "rr_gam_di" Clade specific model - diversity independent (K = Inf) and relaxed colonisation. All other parameters free. "rr_gam_dd" Clade specific model - diversity dependent and relaxed colonisation. All other parameters free. "rr_laa_di" Clade specific model - diversity independent (K = Inf) and relaxed anagenesis. All other parameters free. "rr_laa_dd" Clade specific model - diversity dependent and relaxed anagenesis. All other parameters free. "rr_mu_di_0lac" Clade specific model - diversity independent, relaxed extinction, and no cladogenesis (lac fixed to zero). All other parameters free. "rr_mu_dd_0lac" Clade specific model - diversity dependent, relaxed extinction, and no cladogenesis (lac fixed to zero). All other parameters free. "rr_k_0lac" Clade specific model - diversity dependent, relaxed carrying capacity, and no cladogenesis (lac fixed to zero). All other parameters free. "rr_gam_di_0lac" Clade specific model - diversity independent, relaxed colonisation, and no cladogenesis (lac fixed to zero). All other parameters free. "r_gam_dd_0lac" Clade specific model - diversity dependent, relaxed colonisation, and no cladogenesis (lac fixed to zero). All other parameters free. "rr_laa_di_0lac" Clade specific model - diversity independent, relaxed anagenesis, and no cladogenesis (lac fixed to zero). All other parameters free. "r_laa_dd_0lac" Clade specific model - diversity dependent, relaxed anagenesis, and no cladogenesis (lac fixed to zero). All other parameters free. "rr_lac_di_0laa" Clade specific model - diversity independent, relaxed cladogenesis, and no anagenesis (laa fixed to zero) "rr_lac_dd_0laa" Clade specific model - diversity dependent "rr_mu_di_0laa" Clade specific model - diversity independent "rr_mu_dd_0laa" Clade specific model - diversity dependent "rr_k_0laa" Clade specific model - diversity dependent "rr_gam_di_0laa" Clade specific model - diversity independent, relaxed colonisation, and no anagenesis (laa fixed to zero). All other parameters free "rr_gam_dd_0laa" Clade specific model - diversity dependent, relaxed colonisation, and no anagenesis (laa fixed to zero). All other parameters free
low_rates	Boolean determining whether the random sampling of initial parameter estimates should be sampled from a broad range (FALSE) or from a restricted range where the initial rates a ensured to be smaller (TRUE). The latter helps when using large datasets that may fail the initial likelihood computation with higher rates that could be sampled from the broad range of rates.
par_upper_bound	A numeric defining the upper limit of the integration of a parameter when fitting the relaxed-rate DAISIE model. If the DAISIE model being applied is not the relaxed-rate model, this parameter can be ignored and left as its default as it does not influence the model.

Value

A named list with DAISIE::DAISIE_ML() arguments.

Author(s)

Luis M Valente, Pedro Santos Neves, Joshua W. Lambert

Examples

model <- "cr_dd"
setup_model(
  model = model
)

tece-lab/DAISIEutils documentation built on Jan. 31, 2024, 12:09 p.m.