summarize_mdlrn: summarize_mdlrn

In Allgeier-Lab/arrR: Individual-Based Simulation Model of Artifical Reefs in R

summarize_mdlrn

Description

Summarize results of model run.

Usage

summarize_mdlrn(
  result,
  what = c("seafloor", "fishpop"),
  summary = c("min", "mean", "max"),
  verbose = TRUE
)

Arguments

result	mdl_rn object.
what	Vector with 'seafloor' and/or 'fishpop' to specify what to summarize.
summary	String with summary functions.
verbose	Logical if TRUE, warning messages are printed.

Details

Summarize results for each time step. The summary argument allows to specify which summary statistics are used for each cell. The selected statistics are used by aggregate and must return a single value.

If what='seafloor', the i) bg_biomass, ii) ag_biomass, iii) nutrients_pool, and iv) detritus_pool are returned. If what='fishpop', the i) length, ii) weight, iii) died_consumption, and iv) died_background are returned.

Value

list

Examples

## Not run: 
summarize_mdlrn(result_rand)

## End(Not run)

Allgeier-Lab/arrR documentation built on Feb. 13, 2025, 7:44 a.m.