params_doc: Documentation for main parameters of the model

In TheoPannetier/DDvTDtools: Compare diversity-dependent (DD) and time-dependent (TD) diversification models

Description

This function does nothing. It is intended to inherit is parameters' documentation.

Usage

params_doc(sim, para, optim, init_k, mc, rangemc, brts, with_extinct)

Arguments

sim	character, name of the simulation model, either "DD" or "TD".
para	numeric, a four-digits number coding for a set of four parameter values. Refer to arg_para() doc for details, and call arg_para() to see possible inputs.
optim	character, name of the optimisation model, either "DD" or "TD".
init_k	character code specifying the initial values of parameter K used in the optimisation. Refer to arg_init_k() doc for details, and call arg_init_k() to see possible inputs.
mc	numeric between 1 and 1000, the index of a tree within a dataset.
rangemc	numeric vector, a set of tree indices ranging from 1 to 1000.
brts	numeric vector, a set of branching times as given by ape::branching_times().
with_extinct	logical, should the tree include extinct lineages?

Author(s)

Theo Pannetier, based on skeleton stolen from Richel J.C. Bilderbeek.

TheoPannetier/DDvTDtools documentation built on Oct. 22, 2020, 2:31 p.m.