calculateBalance: Calculate Balance

Description Usage Arguments Value

Description

The function will calculate the balance (in most cases, the difference between supply and utilization) and fill this value into the balanceElement column. However, if this computed value is negative, or if the balanceElement symbol is not replaceable (see ?replaceable) then this computed value is placed in the statistical discrepancy column.

Usage

1
calculateBalance(supply, utilization, balanceElement, data, aupusParam)

Arguments

supply

The column name of data corresponding to the calculated total supply.

utilization

The column correspoding to calculated total utilization.

balanceElement

The column name of data corresponding to the balancing element.

data

The AUPUS node dataset, typically as produced by buildNodes.

aupusParam

A list of running parameters to be used in pulling the data. Typically, this is generated from getAupusParameter (see that function for a description of the required elements).

Value

A logical vector indicating which rows were updated with the balance.


SWS-Methodology/faoswsAupus documentation built on May 9, 2019, 11:45 a.m.