get_dispersal_values: Allows the user to generate dispersal value(s) for a given...

In gen3sis: General Engine for Eco-Evolutionary Simulations

Allows the user to generate dispersal value(s) for a given species. The simulation request the user to return a vector of dispersal values with length specified by the num_draws parameter

Description

Allows the user to generate dispersal value(s) for a given species. The simulation request the user to return a vector of dispersal values with length specified by the num_draws parameter

Usage

get_dispersal_values(num_draws, species, landscape, config)

Arguments

num_draws	the number of dispersal values drawn
species	the species for which the values are to be produced
landscape	the landscape of the current time step
config	the config of the simulation

Details

Dispersal values are used for two different operations. First, for colonization, dispersal values are used to evaluate pairwise dispersal events between colonized and uninhabited sites. Second, for geographic clustering, dispersal values are used during the clustering of species populations when determining which sites are in range of each other and belong to the same geographic cluster.

num_draws tells the user how many dispersal values are requested by the simulation when this function is called and must be returned. It can be of varying length depending on the operation calling it, i.e. colonization or geographic clustering. If the dispersal is considered as fixed the function should return a vector of length num_draws with repeated identical values, or varying values in case of more complex dispersal kernels.

Note: if the distances are randomized the cluster formation may be asymmetrical. Therefore the ordering of all clustering operations is randomized.

Value

a numerical vector of length num_draws with dispersal values

gen3sis documentation built on Nov. 22, 2023, 5:07 p.m.