run_model_biotic: run_model_biotic

In mhesselbarth/rabmp: R agent-based model for plants

Description

Run the model

Usage

run_model_biotic(
  data,
  parameters,
  plot_area = NULL,
  years,
  save_each = NULL,
  return_seedlings = FALSE,
  return_nested = FALSE,
  return_tibble = TRUE,
  verbose = TRUE
)

Arguments

data	Data.table with input data.
parameters	List with all parameters.
plot_area	The plot area as owin object from the spatstat package.
years	Numeric timesteps (years) the model runs.
save_each	Integer value specifying time step results are saved.
return_seedlings	Logical if seeds should be included in final output.
return_nested	Logical if TRUE the final tibble is nested.
return_tibble	Logical if tibble should be returned
verbose	If TRUE, prints progress report.

Details

Wrapper function to run the model. Executes (i) simulate_ci (ii) simulate_growth (iii) simulate_seed_dispersal (iv) simulate_mortality. The input data must be preprocessed using prepare_input.

Parameters include ....

Value

data.table or tibble

Examples

## Not run: 
data <- prepare_data(data = example_input_data,
x = "x_coord", y = "y_coord", type = "Class", dbh = "bhd")

parameters <- read_parameters(file = "inst/parameters_biotic.txt", sep = ";")

result <- run_model_biotic(data = data, parameters = parameters, years = 10)

## End(Not run)

mhesselbarth/rabmp documentation built on Nov. 24, 2021, 10:30 p.m.