getFlowMatrix: Get Flowmatrix from LIM

View source: R/get_Flowmatrix.R

getFlowMatrixR Documentation

Get Flowmatrix from LIM

Description

This function extracts flow data from the LIM and produces a Flowmatrix i.e. flows from sources in rows to the sinks in columns.

Usage

getFlowMatrix(readLIM, web = NULL, lim = NULL, verbose = TRUE)

Arguments

readLIM

(required) A linear inverse model read into the R environment with the R-package LIM. Can be achieved with readLIM <- Read("path_to_input_file")

web

(optional) The solved (food) web problem, i.e. the values of the unknowns; if not specified, the model is solved first, using Ldei.

lim

(optional) The set-up linear problem. Can be achieved with lim <- Setup(readLIM).

verbose

(optional) Should the function provide messages?

Details

This function is an adapted version of the Flowmatrix function from the LIM package. The major difference is that this function also provides the right answer if multiple parallel flows occur between the same two compartments.

Value

Returns a named numeric matrix.

References

LIM package, Soetaert & van Oevelen 2015.


dswdejonge/fwstability documentation built on Dec. 7, 2022, 7:24 p.m.