sfcr_validate: Validate a transactions-flow or balance-sheet matrix

Description Usage Arguments Details Author(s)

View source: R/sfcr_validate.R

Description

This function validates a transactions-flow or balance-sheet matrix with the simulated data obtained with sfcr_baseline() function

Usage

1
sfcr_validate(matrix, baseline, which, tol = 1, rtol = FALSE)

Arguments

matrix

A transactions-flow or balance sheet matrix

baseline

A baseline model.

which

Either "bs" (balance-sheet matrix) or "tfm" (transactions-flow matrix).

tol

A numerical value indicating the absolute accepted discrepancy accepted to validate whether the rows and columns are equal to their expected values.

rtol

A logical value indicating whether relative discrepancies should be evaluated. It defaults to FALSE. Stationary models should pass the test using a absolute level while growth models might need a relative validation since computational discrepancies tend to get larger with the model. See details for further information.

Details

The relative discrepancy is calculated differently if we are dealing with a transactions-flow matrix or with a balance-sheet matrix. If which is set to tfm, the sum of the row/column is evaluated against the sum of the positive entries of that row/column.

For example, in a transactions-flow matrix with three entries in the "change in the stock of bills" row (-Delta (Bhd), + Delta (Bs), and + Delta (Bbd)), the discrepancy d = Delta Bs - Delta Bhd - Delta Bbd is evaluated against Delta Bs, i.e., the row is validated if d/Delta Bs < tol.

In a balance-sheet matrix, all the rows/columns that sum to zero are validated exactly as in a transactions-flow matrix. The exception to this rule is when there is a expected value. In this case, the discrepancy is evaluated as a proportion of the expected. value

To prevent unnecessary calculations, a absolute check with tolerance defined as 1e-3 is executed prior to this evaluation.

The absolute discrepancy set with tol should be enough to validate a stationary SFC Model.

Author(s)

João Macalós


sfcr documentation built on Oct. 11, 2021, 9:09 a.m.