grattanInflators (version 0.5.4)

lf_inflator: Labour force inflator

Description

Uses the Labour Force Index to provide equivalent sizes of the labour force over different times by multiplying by the simple ratio of the sizes on those dates.

Usage

lf_inflator(
  from = NULL,
  to = NULL,
  check = 1L,
  series = lfi_original(),
  fy_month = 3L,
  x = NULL,
  nThread = getOption("grattanInflators.nThread", 1L)
)
lfi_original(..., FORECAST = FALSE, LEVEL = "mean")
lfi_seasonal(..., FORECAST = FALSE, LEVEL = "mean")
lfi_trend(..., FORECAST = FALSE, LEVEL = "mean")

Value

If `x` is `NULL`, the default, a numeric vector matching the lengths of `from` and `to` equal to the relative size of the labour force of `from` and `to`.

If `x` is numeric, it is taken to be the sizes of the labour force on dates `from` and the value returned is the equivalent size of `x` on dates `to` (by simple multiplication).

Arguments

from, to

Times for which the inflator is desired. If NULL, a date range close to the previous year is used.

check

integer(1) If 0L, no checks are performed, and clearly invalid inputs result in NA in the output. If check = 1L an error is performed for bad input; check = 2L is more thorough.

series

A call to `lfi_original()`, `lfi_seasonal()`, or `lfi_trend()`.

fy_month

The month to be used in `series` for financial years.

x

(Advanced) A vector that will be inflated in-place. If NULL, the default, the return vector is simply the inflation factor for `from`.

nThread

Number of threads to use.

...

Set of date-rate pairs for custom labour force series in the future.

FORECAST

Whether the series should be extended via an ETS forecast.

LEVEL

If `FORECAST = TRUE` what prediction interval should be used. (`LEVEL = 20` means the lower end of an 80% prediction interval.) If `LEVEL = "mean"` (the default), the central estimate is used.

Examples

# The relative size of the labour force in FY 2016-17
# compared to FY 2015-16
lf_inflator("2015-16", "2016-17")