update.sim_data: Update 'sim_data' Object

View source: R/update.sim_data.R

update.sim_dataR Documentation

Update sim_data Object

Description

This function updates a sim_data object.

Usage

## S3 method for class 'sim_data'
update(object, ..., evaluate = TRUE)

Arguments

object

sim_data object; returned by initialise function

...

further arguments passed to or from other methods; currently none specified

evaluate

logical vector of length 1; if TRUE evaluates the new call, otherwise returns the call

Value

If evaluate = TRUE then the updated sim_data object, otherwise the updated call.

Examples



# data preparation
library(terra)
n1_small <- rast(system.file("input_maps/n1_small.tif", package = "rangr"))
K_small <- rast(system.file("input_maps/K_small.tif", package = "rangr"))

sim_data_1 <- initialise(
  n1_map = n1_small,
  K_map = K_small,
  r = log(2),
  rate = 1 / 1e3
)
summary(sim_data_1)

sim_data_2 <- update(sim_data_1, max_dist = 3000)
summary(sim_data_2)




rangr documentation built on April 12, 2025, 1:40 a.m.