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

In richelbilderbeek/becosys: Unified Interface To Phylogenetics Models Of Speciation

Description

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

Usage

default_params_doc(
  conditioned_on,
  crown_age,
  erg,
  eri,
  ext_rate,
  init_n_species,
  lambda,
  mbd_params,
  mbd_params_selector,
  mu,
  nu,
  pbd_params,
  pbd_params_selector,
  pbd_sim_out,
  q,
  quantile,
  scr,
  sir,
  sirg,
  siri,
  spec_rate,
  stem_age
)

Arguments

conditioned_on	what the process is conditioned on. This can be either 'nothing' or 'non_extinction'"
crown_age	the crown age, in time units ago
erg	extinction rate of a good species
eri	extinction rate of an incipient species
ext_rate	per-lineage extinction rate
init_n_species	initial number of species at the start of simulating a phylogeny. Can be 1 (to start at the stem) or 2 (to start at the crown)
lambda	the sympatric speciation rate
mbd_params	parameter set for the MBD model, as can be created by create_mbd_params
mbd_params_selector	a structure to select MBD parameters, as can be created by create_mbd_params_selector
mu	the extinction rate
nu	the multiple allopatric speciation trigger rate
pbd_params	parameter set for the PBD model, as can be created by create_pbd_params
pbd_params_selector	a structure to select PBD parameters, as can be created by create_pbd_params_selector
pbd_sim_out	the result of a call to pbd_sim_checked
q	the single-lineage speciation probability at a triggered event
quantile	a quantile, a value between (and including) zero to (and including) one.
scr	speciation completion rate
sir	speciation initiation rate
sirg	speciation initiation rate of a good species
siri	speciation initiation rate of an incipient species
spec_rate	per-lineage speciation rate
stem_age	the stem age, in time units ago

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, use of this function by Richel J.C. Bilderbeek

richelbilderbeek/becosys documentation built on Oct. 19, 2020, 9:20 a.m.