getCE: Get conversion efficiencies from a LIM.

View source: R/extract_lim_data.R

getCER Documentation

Get conversion efficiencies from a LIM.

Description

This function calculates assimilation and growth efficiencies from a given LIM.

Usage

getCE(FM, vars, lim, aTag = NULL, gTag = NULL, verbose = TRUE)

Arguments

FM

(required) A flow matrix with flows from source in rows to sink in columns.

vars

(required) A named vector with the values of variables defined in the LIM.

lim

(required) Setup(Read(lim.input))

aTag

(optional) Tag assigned to the variables representing the assimilated amount of material. Default is set to "ass". Not case sensitive.

gTag

(optional) Tag assigned to the variables representing growth. Default is set to "growth". Not case sensitive.

verbose

(optional) Should the function provide messages?

Details

In order for this function to work, the LIM must be set-up in a specific way. The variables representing total assimilation and growth of an organism must be named as: "compartmentTag" or "tagCompartment" (not case sensitive). All non-dead organisms must have a variable with assimilation and growth. For more information on setting up the LIM, please review the vignette.

The assimilation efficiency is calculated as amount of assimilated material divided by the total ingestion. Growth (or secondary production) efficiency is calculated by dividing growth by the amount of assimilated material.

Value

Returns a list with element "AE" (named vector with assimilation efficiencies) and element "GE" (named vector with growth efficiencies).

References

LIM package, Soetaert & van Oevelen 2015.


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