extract_spatial: Extract spatial object from a 'simulation_results' object

In steps-dev/steps: Spatially- and Temporally-Explicit Population Simulator

Extract spatial object from a 'simulation_results' object

Description

The simulation results object is a list of lists containing spatial (and other) objects and is organised by the following tree diagram:

• Replicate

  • Timestep

    • Population Raster Stack

      • Life-Stage Raster

    • Habitat Suitability Raster (or Stack)

      • Habitat Raster (if stack is used)

    • Carrying Capacity Raster

    • Other Raster Stack

      • Raster

    • ...

Usage

extract_spatial(
  x,
  replicate = 1,
  timestep = 1,
  landscape_object = "population",
  stage = 1,
  misc = 1
)

Arguments

x	a simulation_results object
replicate	which replicate to extract from a simulation_results object
timestep	which timestep to extract from a simulation_results
landscape_object	which landscape object to extract from a simulation_results object - can be specified by name (e.g. "suitability") or index number
stage	which life-stage to extract from a simulation_results object - only used for 'population' components of the landscape object
misc	which misc object to extract from a simulation_results object - only used for additional spatial objects added to a landscape (e.g. disturbance layers)

Examples

## Not run: 
ls <- landscape(population = egk_pop, suitability = egk_hab, carrying_capacity = egk_k)

pd <- population_dynamics(change = growth(egk_mat),
                          dispersal = kernel_dispersal(max_distance = 2000,
                                        dispersal_kernel = exponential_dispersal_kernel(
                                          distance_decay = 1000)),
                          density_dependence = ceiling_density())

sim <- simulation(landscape = ls,
                  population_dynamics = pd,
                  habitat_dynamics = NULL,
                  timesteps = 20)

# Extract the population raster for the second life-stage in the first
# replicate and ninth timestep
extract_spatial(sim, replicate = 1, timestep = 9, stage = 2)

## End(Not run)

steps-dev/steps documentation built on Dec. 9, 2023, 10:51 p.m.