summarise: Methods for summarising simulation results

In flee-group/flume: A Model For Fluvial Meta-Ecosystems

Methods for summarising simulation results

Description

Methods for summarising simulation results

Usage

summarise(x, by = c("time", "reach"), stat, quantile = c(0.05, 0.95))

Arguments

x	A fitted flume model
by	The margin(s) across which to summarise; see 'details'
stat	The statistic(s) to compute; see 'details'
quantile	The quantiles to compute; see 'details'
network

Details

The by parameter controls how detailed of a summary to create; adding more margins creates a more detailed summary. The default behaviour provides statistics for each time step and each reach, with quantiles computed across replicate networks. Allowable values:

• time

• reach

• species (incompatible with resources)

• resources (incompatible with species)

The statistics desired interact with the margins selected; certain values for stat are only compatible with specific values within by. If missing, a default set will be selected given the value in by. Allowable values, with compatible margins in parentheses, and required margins in bold:

• occupany (species, reach, time)

• EF (resources, reach, time)

• richness (reach, time)

If the fitted model includes multiple replicate networks, then summarise by default returns upper and lower quantiles along with the median, summarised across networks. Only two quantiles may be provided. If quantile is NULL, then all replicates will be returned.

Value

A data.table with the desired summary statistics

flee-group/flume documentation built on Jan. 29, 2024, 6:44 p.m.