enaEnviron: Ecological Network Environs

In SEELab/enaR: Tools for Ecological Network Analysis

Ecological Network Environs

Description

Calculates the environs for an ecological network.

Usage

enaEnviron(x, input = TRUE, output = TRUE, type = "unit",
  err.tol = 1e-10, balance.override = FALSE)

Arguments

x	A network object.
input	Should the input environ be calculated?
output	Should the output environ be calculated?
type	Specifies the type of environs ("unit" or "realized") to be calculated.
err.tol	Error threshold for numerical error fluctuations in flows. Values below err.tol will be set to zero.
balance.override	Logical specifying whether (TRUE) or not (FALSE) the model needs to be balanced prior to calculations. If TRUE and the model is not balanced, environs will not be calculated.

Value

The function returns the input, output or both environs depending upon which were requested.

Author(s)

Stuart R. Borrett Matthew K. Lau

References

Fath, B.D. and S.R. Borrett. 2006. A MATLAB function for network environ analysis. Environmental Modelling & Software 21:375-405.

Examples

data(troModels)
enaEnviron(troModels[[6]])

SEELab/enaR documentation built on April 29, 2023, 8:40 a.m.