Skip to contents

Declare a model variable with a label and unit

Source: R/dsl-vars.R
var.Rd

Used inside vars() to attach documentation to a variable. Units are stored and displayed; unit algebra (automatic consistency checking inside equations) is on the roadmap.

Usage

var(label = "", unit = "", ...)

Arguments

label

Human-readable description, e.g. "Output gap" (or numeric data, which is passed to stats::var()).

unit

Unit of measurement, e.g. "pp", "pct pa".

...

Passed to stats::var() in the delegation case.

Value

An object of class qpm_var, or the result of stats::var().

Details

When given numeric data instead of a character label, var() delegates to stats::var(), so attaching qpmR does not break variance computations.

Examples

vars(y_gap = var("Output gap", unit = "pp"))
#>    name      label unit
#> 1 y_gap Output gap   pp
var(rnorm(10))  # still the sample variance
#> [1] 0.6425765