default_params_doc: This function does nothing. It is intended to inherit is...

In Giappo/mbd.SimTrees: Use mbd to estimate number of taxa and strength of the mb signal in simulated trees

Description

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

Usage

default_params_doc(bins, cond, crown_age, lambda, lambdas, mu, mus,
  n_replicates, nu, nus, q, qs, saveit, seed, var, verbose)

Arguments

bins	number of bins
cond	Conditioning
crown_age	The crown age of the tree
lambda	per-lineage speciation rate. See mbd_sim
lambdas	per-lineage speciation rate. See mbd_sim
mu	per-species extinction rate. See mbd_sim
mus	per-species extinction rate. See mbd_sim
n_replicates	number of replicates
nu	the rate at which a multiple-birth specation is triggered.
nus	the rate at which a multiple-birth specation is triggered.
q	per-species speciation probability in case of occurrance of
qs	per-species speciation probability in case of occurrance of
saveit	do you want to save it?
seed	a random number generator seed
var	a variable
verbose	give more output

Note

This is an internal function, so it should be marked with @noRd. This is not done, as this will disallow all functions to find the documentation parameters

Author(s)

Documentation by Giovanni Laudanno.

Giappo/mbd.SimTrees documentation built on Jan. 23, 2020, 3:40 a.m.