set_benchmarking: Set Benchmarking Specification

View source: R/set_benchmarking.R

set_benchmarkingR Documentation

Set Benchmarking Specification

Description

Set Benchmarking Specification

Usage

set_benchmarking(
  x,
  enabled = NA,
  target = c(NA, "CalendarAdjusted", "Normal"),
  rho = NA,
  lambda = NA,
  forecast = NA,
  bias = c(NA, "None")
)

Arguments

x

the specification.

enabled

boolean to enable the user to perform benchmarking.

target

specifies the target variable for the benchmarking procedure, which can be the raw series ("Original"); or the series adjusted for calendar effects ("CalendarAdjusted").

rho

the value of the AR(1) parameter (set between 0 and 1) in the function used for benchmarking.

lambda

a parameter in the function used for benchmarking that relates to the weights in the regression equation; it is typically equal to 0, 1/2 or 1.

forecast

boolean indicating if the forecasts of the seasonally adjusted series and of the target variable (target) are used in the benchmarking computation so the benchmarking constrain is applied also to the forecasting period.

bias

TODO


palatej/rjd3modelling documentation built on Jan. 3, 2023, 10:19 p.m.