default_params_doc: Default parameter documentation

In Neves-P/phylometricsims: Simulate DAISIE Islands for Phylogenetic Metric Comparison

Description

This function does not do anything. It is meant to hold argument documentation, which is then inherited in all other functions.

Usage

default_params_doc(
  totaltime,
  sim_pars,
  n_mainland_spec,
  iw_sims,
  param_set,
  brts,
  n_param_sets_to_run,
  save_to_file,
  test_seed
)

Arguments

totaltime	Positive numeric. Specifies how the age of the island to be simulated by DAISIE::DAISIE_sim_constant_rate().
sim_pars	Numeric vector with DAISIE simulation parameters, as used by DAISIE::DAISIE_sim_constant_rate(): simID, an integer with the ID of the parameters. Not used in the simulation. Cladogenesis rate (λ^c). Extinction rate μ. Island-wide carrying capacity (K'). Immigration rate γ. Anagenesis rate λ^a. Totaltime: the island age.
n_mainland_spec	Positive integer with total number of species in the mainland pool, which can colonize the island.
iw_sims	DAISIE object (list) as generated by run_iw_sims().
param_set	Positive integer. Corresponds to one line of the param_space data frame.
brts	List with vector of branching times as returned by
n_param_sets_to_run	Integer with number of parameter sets (i.e., columns in the parameter space file) should be simulated.
save_to_file	Boolean stating if output of pipeline should be saved as an .rds file in ./output/
test_seed	A boolean, which sets the seed to 1. Defaults to FALSE, should only be set to TRUE for testing.

Value

Nothing

Note

Should be marked as @noRd, but this can't be done or inheriting parameters would not be possible.

Author(s)

Pedro Neves

Neves-P/phylometricsims documentation built on June 3, 2021, 3:21 p.m.