invasion.front: Calculate the progressive occupancy of an array of hexagons

Description Usage Arguments Value

View source: R/invasion.front.R

Description

The user has to set up an array of patches (which may comprise of one or more hexagons) and then determine the occupancy of these patches during the simulations. This can be achieved by generating a sequenced trait linked to an accumulator that it is updated with an 'individual location' updater. Finally, by setting up a census event that summarises the number of individuals within each patch, it will be possible to use this function to calculate the progress of the front of invasion across the array of hexagons.

The census file where the data is stored is identified with the argument ncensus. Remember that by default HexSim names the census files with the name of the scenario, followed by the 'number' of the census event. This 'number' will depend on how many census event you have in the HexSim sequence. The first census event will be saved with the number 0, the second with the number 1 and so forth. The number of the census file that holds the individual location data is the one that need to be passed to ncensus so that HexSimR knows which one to pick to carry out the calculations.

Usage

1
2
3
4
5
6
7
invasion.front(
  path.results = NULL,
  ncensus,
  value = 1,
  patch.width,
  scenarios = "all"
)

Arguments

path.results

The path to the 'Results' folder

ncensus

The census number to be processed

value

The threshold occupancy value

patch.width

The width of the patch

scenarios

A character vector with the scenarios to be processed or "all"

Value

A list with three elements: the mean and standard deviation for each time step and overall.


carlopacioni/HexSimR documentation built on Nov. 28, 2020, 4:12 p.m.