default_params_doc {nLTT}

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

Description

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

Usage

default_params_doc(dt, phylogenies, step_type, time_unit)

Arguments

dt

The timestep resolution, a value bigger than zero and less or equal to one. 1/dt is the number of points that will be evaluated

phylogenies

a collection of one or more phylogenies, where the phylogenies are of type phylo. This collection can both be a list of phylo or a multiphylo.

step_type

when between two points, where the second point has both a higher x and y coordinat, which y coordinat to follow. 'step_type' can be:

• lower maintain the y-coordinat of the leftmost point

• upper already use the y-coordinat of the rightmost point

time_unit

the time unit of the branching times

• "ago: "the branching times are postive, as these are in time units ago

• "since: "the branching times are negative, as these are in time units since present

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)

Richèl J.C. Bilderbeek