population_dynamics: Modify the population in a state object.

Description Usage Arguments Details Value Examples

View source: R/population_dynamics-class.R

Description

A population_dynamics object is used to modify species populations in space and time.

Usage

1
2
3
4
5
6
7
population_dynamics(change = simple_growth(), disp = NULL,
  mod = NULL, dens_dep = NULL)

is.population_dynamics(x)

## S3 method for class 'population_dynamics'
print(x, ...)

Arguments

change

a population_dynamics_functions to define how population growth occurs at each timestep

disp

a function to define how the population disperses at each timestep (default is exponential kernel)

mod

a function to define any deterministic changes to the population - such as translocation - at each timestep

dens_dep

a function to control density dependence effects on the population at each timestep

x

a population_dynamic object

...

further arguments passed to or from other methods

Details

A population_dynamics object is a sub-component of a dynamics object and is executed in each timestep of a simulation. Note, some dynamics functions can be executed at non-regular intervals (i.e. only timesteps explicitly defined by the user). The population_dynamics function is used to construct a population dynamics object consisting of several population dynamics functions and their associated parameters. These functions specify how the population in the state object will be modified throughout a simulation.

Value

An object of class population_dynamics

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
library(steps)
library(raster)

# Construct a population dynamics object - note non-specified parameters
uses default population growth function based on transition matrices
pop_dynamics <- population_dynamics()

# Test if object is of the type 'population dynamics'
is.population_dynamics(test_pop_dynamics)

# Print details about the 'population_dynamics' object 
print(test_pop_dynamics)

skiptoniam/dhmpr documentation built on Sept. 26, 2018, 3:11 p.m.