population_transformation: Nested functions for a user-defined population abundance (and...

In poems: Pattern-Oriented Ensemble Modeling System

Nested functions for a user-defined population abundance (and capacity) transformation.

Description

Modular functions for the population simulator for performing a transformation of the stage abundance (and optionally carrying capacity) at a specified time step via a user-defined function.

Usage

population_transformation(
  replicates,
  time_steps,
  years_per_step,
  populations,
  demographic_stochasticity,
  density_stages,
  transformation,
  simulator,
  name = "transformation"
)

Arguments

replicates	Number of replicate simulation runs.
time_steps	Number of simulation time steps.
years_per_step	Number of years per time step.
populations	Number of populations.
demographic_stochasticity	Boolean for optionally choosing demographic stochasticity for the transformation.
density_stages	Array of booleans or numeric (0,1) for each stage to indicate which stages are affected by density.
transformation	A user-defined function (optionally nested in a list with additional attributes) for performing transformation: function(params), where params is a list passed to the function containing: replicates Number of replicate simulation runs. time_steps Number of simulation time steps. years_per_step Number of years per time step. populations Number of populations. stages Number of life cycle stages. demographic_stochasticity Boolean for optionally choosing demographic stochasticity for the transformation. density_stages Array of booleans or numeric (0,1) for each stage to indicate which stages are affected by density. r Simulation replicate. tm Simulation time step. carrying_capacity Array of carrying capacity values for each population at time step. stage_abundance Matrix of (current) abundance for each stage (rows) and population (columns) at time step. occupied_indices Array of indices for populations occupied at (current) time step. simulator SimulatorReference object with dynamically accessible attached and results lists. additional attributes Additional attributes when the transformation is optionally nested in a list. returns a transformed stage abundance matrix (or a list with stage abundance and carrying capacity)
simulator	SimulatorReference object with dynamically accessible attached and results lists.
name	Optional name for the transformation (default is "transformation").

Value

Abundance (and capacity) transformation function: function(r, tm, carrying_capacity, stage_abundance, occupied_indices), where:

r

Simulation replicate.

tm

Simulation time step.

carrying_capacity

Array of carrying capacity values for each population at time step.

stage_abundance

Matrix of abundance for each stage (rows) and population (columns) at time step.

occupied_indices

Array of indices for populations occupied at time step.

returns

List with transformed stage abundance matrix (and optionally carrying capacity).

poems documentation built on Oct. 7, 2023, 9:06 a.m.