trollstack {rcontroll}

A stack of TROLL simulations

Description

trollstack() is an S4 class to represent a stack of TROLL simulation. trollstack values can be accessed using object attributes in the form of simple R objects (with @). They consist of eight simulation attributes: (1) name, (2) path to saved files, (3) parameters, (4) inputs, (5) log, (6) initial and final state, (7) ecosystem output metrics, and (8) species output metrics. The initial and final states are represented by a table with the spatial position, size and other relevant traits of all trees at the start and end of the simulation. The ecosystem and species metrics are summaries of ecosystem processes and states, such as net primary production and aboveground biomass, and they are documented at species level and aggregated over the entire stand.

Usage

trollstack(
  name = character(),
  path = character(),
  mem = logical(),
  parameters = numeric(),
  inputs = list(),
  log = character(),
  forest = data.frame(),
  ecosystem = data.frame(),
  species = data.frame(),
  las = list()
)

Arguments

name

char. Simulation name.

path

char. File path to the stack of simulation (parent folder).

mem

bool. Is the simulation in memory, see load_sim().

parameters

numeric. Parameters of the simulation (general inputs).

inputs

list. Simulation inputs (species, climate, daily, forest, lidar, see stack()).

log

chr. Simulation log, see get_log().

forest

df. Simulation initial and final forest, see get_forest().

ecosystem

df. Ecosystem metrics.

species

df. Species metrics (with OUTPUT_extended option, see generate_parameters()).

las

list. List with simulated point cloud in LAS from lidar parameters (with lidar option, see generate_lidar()). The LAS format correspond to lidR::LAS().

Value

An empty S4 trollstack() class object.

See Also

stack(), load_stack(), trollsim()