diff --git a/R/modellingcontext.R b/R/modellingcontext.R index 1c02c4e..9b8b2c2 100644 --- a/R/modellingcontext.R +++ b/R/modellingcontext.R @@ -284,7 +284,7 @@ dynamic_ts<-function(moniker, data){ #' # creating the modelling context #' my_context<-modelling_context(variables=vars) #' # customize a default specification -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<- add_usrdefvar(init_spec,id = "reg1.iv1", regeffect="Trend") #' # modelling context is needed for the estimation phase #' # sa_x13<- rjd3x13::x13(ABS$X0.2.09.10.M, new_spec, context = my_context) diff --git a/R/spec_benchmarking.R b/R/spec_benchmarking.R index 4d84e51..86629eb 100644 --- a/R/spec_benchmarking.R +++ b/R/spec_benchmarking.R @@ -15,12 +15,12 @@ #' @param forecast Boolean indicating if the forecasts of the seasonally adjusted series and of the target variable (\code{target}) are used in the benchmarking computation so that the benchmarking constrain is also applied to the forecasting period. #' @param bias TODO #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). #' @examples -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<- set_benchmarking(init_spec, #' # enabled = TRUE, #' # target = "Normal", diff --git a/R/spec_regarima.R b/R/spec_regarima.R index 769aebe..b7c2c13 100644 --- a/R/spec_regarima.R +++ b/R/spec_regarima.R @@ -12,14 +12,14 @@ #' @param coef the coefficient if needs to be fixed. If equal to 0 the outliers/ramps coefficients #' are estimated. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). #' If a Seasonal adjustment process is performed, each type of Outlier will be allocated to a pre-defined #' component after the decomposition: "AO" and "TC" to the irregular, "LS" and Ramps to the trend. #' @examples -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<-rjd3toolkit::add_outlier(init_spec, type="AO", date="2012-01-01") #' # ramp on year 2012 #' # new_spec<-rjd3toolkit::add_ramp(init_spec,start="2012-01-01",end="2012-12-01") @@ -230,12 +230,12 @@ remove_ramp.default <- function(x, #' @param preprocessing (REGARIMA/X13 Specific) a Boolean to enable/disable the pre-processing. #' Option disabled for the moment. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). #' @examples -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # estimation on sub-span between two dates (date d1 is excluded) #' # new_spec<-set_basic(init_spec,type = "Between",d0 = "2014-01-01", #' # d1 = "2019-01-01", preliminary.check = TRUE, preprocessing = TRUE) @@ -312,7 +312,7 @@ set_basic.default <- function(x, #' (non-seasonal, seasonal) is increased.(Default value: 0.96) #' #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). @@ -402,7 +402,7 @@ set_estimate.default <- function(x, #' for parameter estimation in the intermediate steps. If \code{TRUE}, an exact likelihood estimation method is used. #' When \code{FALSE}, the fast Hannan-Rissanen method is used. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). @@ -578,12 +578,12 @@ set_outlier.default <- function(x, #' @param amicompare (TRAMO Specific) \code{logical}. If `TRUE`, the program compares the model identified by the automatic procedure to the default model (\eqn{ARIMA(0,1,1)(0,1,1)}) #' and the model with the best fit is selected. Criteria considered are residual diagnostics, the model structure and the number of outliers. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). #' @examples -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<-set_automodel(init_spec, #' # enabled = FALSE, #' # acceptdefault = TRUE) @@ -712,14 +712,14 @@ set_automodel.default <- function(x, #' \code{"Fixed"} = the coefficients are fixed at the value provided by the user, #' \code{"Initial"} = the value defined by the user is used as the initial condition. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). #' @seealso \code{\link{set_automodel}}, \code{\link{set_transform}} #' @examples #' # create default spec -#' # my_spec<-rjd3x13::spec_x13("rsa5c") +#' # my_spec<-rjd3x13::x13_spec("rsa5c") #' # disable automatic arima modelling #' # my_spec<-set_automodel(my_spec, enabled = FALSE) #' # customize arima model @@ -921,7 +921,7 @@ set_arima.default <- function(x, #' @param leapyear.coef coefficient of the leap year regressor. #' @param coef.type,leapyear.coef.type vector defining if the coefficients are fixed or estimated. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). @@ -932,7 +932,7 @@ set_arima.default <- function(x, #' @examples #' # Pre-defined regressors #' # y_raw<-ABS$X0.2.09.10.M -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<-set_tradingdays(init_spec, #' # option = "TD4", #' # test = "None", @@ -958,7 +958,7 @@ set_arima.default <- function(x, #' ## put into a context #' my_context<-modelling_context(calendars = list(cal=BE)) #' ## create a specification -#' #init_spec <- rjd3x13::spec_x13("RSA5c") +#' #init_spec <- rjd3x13::x13_spec("RSA5c") #'## modify the specification #' # new_spec<-set_tradingdays(init_spec, #' # option = "TradingDays", calendar.name="cal") @@ -966,7 +966,7 @@ set_arima.default <- function(x, #' # sa<-rjd3x13::x13(y_raw,new_spec, context=my_context) #' #' # User-defined regressors -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # add regressors to context #' # variables<-list(Monday,Tuesday, Wednesday, #' # Thursday, Friday, Saturday) @@ -1191,7 +1191,7 @@ set_tradingdays.default <- function(x, #' \code{"IncludeEaster"} = influences the entire period (\code{n}) up to and including Easter Sunday; #' \code{"IncludeEasterMonday"} = influences the entire period (\code{n}) up to and including Easter Monday. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). @@ -1200,7 +1200,7 @@ set_tradingdays.default <- function(x, #' More information on calendar correction in JDemetra+ online documentation: #' \url{https://jdemetra-new-documentation.netlify.app/a-calendar-correction} #' @examples -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<-set_easter(init_spec, #' # enabled = TRUE, #' # duration = 12, @@ -1312,7 +1312,7 @@ set_easter.default <- function(x, enabled = NA, #' \code{transform.fct}> 1 favors levels, \code{transform.fct}< 1 favors logs. #' Considered only when \code{fun = "Auto"}. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). @@ -1321,7 +1321,7 @@ set_easter.default <- function(x, enabled = NA, #' More information in JDemetra+ online documentation: #' \url{https://jdemetra-new-documentation.netlify.app/} #' @examples -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<- set_transform(init_spec, #' # fun = "Log", #' # outliers = TRUE) @@ -1401,7 +1401,7 @@ set_transform.default <- function(x, #' @param regeffect component to which the effect of the user-defined variable will be assigned. #' By default (`"Undefined"`), see details. #' @details -#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +#' \code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} #' (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" #' generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with #' \code{rjd3tramoseats::spec_tramo()}). @@ -1433,7 +1433,7 @@ set_transform.default <- function(x, #' # creating the modelling context #' my_context<-modelling_context(variables=vars) #' # customize a default specification -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # regressors have to be added one by one #' # new_spec<- add_usrdefvar(init_spec,name = "reg1.iv1", regeffect="Trend") #' # new spec<- add_usrdefvar(new_spec,name = "reg2.iv2", regeffect="Trend", coef=0.7) diff --git a/R/variables.R b/R/variables.R index edeb1ac..0e973f5 100644 --- a/R/variables.R +++ b/R/variables.R @@ -256,7 +256,7 @@ ramp_variable<-function(frequency, start, length, s, range){ #' # creating the modelling context #' my_context<-modelling_context(variables=vars) #' # customize a default specification -#' # init_spec <- rjd3x13::spec_x13("RSA5c") +#' # init_spec <- rjd3x13::x13_spec("RSA5c") #' # new_spec<- add_usrdefvar(init_spec,id = "reg1.iv1", regeffect="Trend") #' # modelling context is needed for the estimation phase #' # sa_x13<- rjd3x13::x13(ABS$X0.2.09.10.M, new_spec, context = my_context) diff --git a/README.html b/README.html new file mode 100644 index 0000000..c4a7605 --- /dev/null +++ b/README.html @@ -0,0 +1,645 @@ + + + + + + + + + + + + + + + + + + + + + +

rjd3toolkit

+ + +

R-CMD-check

+ + +

Utility package in JDemetra+ 3.x R ecosystem. Contains functions used +in other rjd3 packages and has to be systematically +installed before using any other rjd3 package.

+

Main Functions

+ +

Installation

+

Running rjd3 packages requires Java 17 or higher. +How to set up such a configuration in R is explained here

+

To get the current stable version (from the latest release):

+
# install.packages("remotes")
+remotes::install_github("rjdverse/rjd3toolkit@*release")
+

To get the current development version from GitHub:

+
# install.packages("remotes")
+remotes::install_github("rjdverse/rjd3toolkit")
+

Package Maintenance and +contributing

+

Any contribution is welcome and should be done through pull requests +and/or issues. pull requests should include updated +tests and updated documentation. If +functionality is changed, docstrings should be added or updated.

+

Licensing

+

The code of this project is licensed under the European +Union Public Licence (EUPL).

+ + + diff --git a/man/add_outlier.Rd b/man/add_outlier.Rd index cd2812a..c77c8ec 100644 --- a/man/add_outlier.Rd +++ b/man/add_outlier.Rd @@ -34,7 +34,7 @@ Generic function to add outliers or Ramp regressors (\code{add_outlier()} and \c to a specification or to remove them (\code{remove_outlier()} and \code{remove_ramp()}). } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). @@ -42,7 +42,7 @@ If a Seasonal adjustment process is performed, each type of Outlier will be allo component after the decomposition: "AO" and "TC" to the irregular, "LS" and Ramps to the trend. } \examples{ -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<-rjd3toolkit::add_outlier(init_spec, type="AO", date="2012-01-01") # ramp on year 2012 # new_spec<-rjd3toolkit::add_ramp(init_spec,start="2012-01-01",end="2012-12-01") diff --git a/man/add_usrdefvar.Rd b/man/add_usrdefvar.Rd index 7c214fd..e169a0b 100644 --- a/man/add_usrdefvar.Rd +++ b/man/add_usrdefvar.Rd @@ -39,7 +39,7 @@ a specification, the external regressor(s) will also have to be added to a model before being used in an estimation process. see \code{\link{modelling_context}} and example. } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). @@ -74,7 +74,7 @@ vars<-list(reg1=list(iv1 = iv1),reg2=list(iv2 = iv2) ) # creating the modelling context my_context<-modelling_context(variables=vars) # customize a default specification -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # regressors have to be added one by one # new_spec<- add_usrdefvar(init_spec,name = "reg1.iv1", regeffect="Trend") # new spec<- add_usrdefvar(new_spec,name = "reg2.iv2", regeffect="Trend", coef=0.7) diff --git a/man/intervention_variable.Rd b/man/intervention_variable.Rd index 350a1b7..78ef25a 100644 --- a/man/intervention_variable.Rd +++ b/man/intervention_variable.Rd @@ -60,7 +60,7 @@ vars<-list(reg1=list(x = iv1),reg2=list(x = iv2) ) # creating the modelling context my_context<-modelling_context(variables=vars) # customize a default specification -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<- add_usrdefvar(init_spec,id = "reg1.iv1", regeffect="Trend") # modelling context is needed for the estimation phase # sa_x13<- rjd3x13::x13(ABS$X0.2.09.10.M, new_spec, context = my_context) diff --git a/man/modelling_context.Rd b/man/modelling_context.Rd index adfacfa..de576e2 100644 --- a/man/modelling_context.Rd +++ b/man/modelling_context.Rd @@ -31,7 +31,7 @@ vars<-list(reg1=list(x = iv1),reg2=list(x = iv2) ) # creating the modelling context my_context<-modelling_context(variables=vars) # customize a default specification -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<- add_usrdefvar(init_spec,id = "reg1.iv1", regeffect="Trend") # modelling context is needed for the estimation phase # sa_x13<- rjd3x13::x13(ABS$X0.2.09.10.M, new_spec, context = my_context) diff --git a/man/set_arima.Rd b/man/set_arima.Rd index 28dd6cd..66e0134 100644 --- a/man/set_arima.Rd +++ b/man/set_arima.Rd @@ -47,14 +47,14 @@ Function allowing to customize the ARIMA model structure when the automatic modelling is disabled.(see example) } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). } \examples{ # create default spec -# my_spec<-rjd3x13::spec_x13("rsa5c") +# my_spec<-rjd3x13::x13_spec("rsa5c") # disable automatic arima modelling # my_spec<-set_automodel(my_spec, enabled = FALSE) # customize arima model diff --git a/man/set_automodel.Rd b/man/set_automodel.Rd index a970f5d..bca1cfe 100644 --- a/man/set_automodel.Rd +++ b/man/set_automodel.Rd @@ -90,13 +90,13 @@ and the model with the best fit is selected. Criteria considered are residual di Function allowing to customize Arima model identification procedure. } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). } \examples{ -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<-set_automodel(init_spec, # enabled = FALSE, # acceptdefault = TRUE) diff --git a/man/set_basic.Rd b/man/set_basic.Rd index 05f0def..dcae4a5 100644 --- a/man/set_basic.Rd +++ b/man/set_basic.Rd @@ -40,13 +40,13 @@ Function allowing to check if the series can be processed and to define a sub-sp estimation will be performed } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). } \examples{ -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # estimation on sub-span between two dates (date d1 is excluded) # new_spec<-set_basic(init_spec,type = "Between",d0 = "2014-01-01", # d1 = "2019-01-01", preliminary.check = TRUE, preprocessing = TRUE) diff --git a/man/set_benchmarking.Rd b/man/set_benchmarking.Rd index 77760eb..b2913f2 100644 --- a/man/set_benchmarking.Rd +++ b/man/set_benchmarking.Rd @@ -37,13 +37,13 @@ seasonally adjusted and raw (or calendar adjusted) data, as seasonal adjustment and the corresponding annual totals of raw (or calendar adjusted) series. } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). } \examples{ -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<- set_benchmarking(init_spec, # enabled = TRUE, # target = "Normal", diff --git a/man/set_easter.Rd b/man/set_easter.Rd index 8e3e690..9d13af6 100644 --- a/man/set_easter.Rd +++ b/man/set_easter.Rd @@ -49,13 +49,13 @@ Possible procedures are: \code{"Estimated"} = coefficient is estimated, Set Easter effect correction in Pre-Processing Specification } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). } \examples{ -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<-set_easter(init_spec, # enabled = TRUE, # duration = 12, diff --git a/man/set_estimate.Rd b/man/set_estimate.Rd index 788c189..2ebe48a 100644 --- a/man/set_estimate.Rd +++ b/man/set_estimate.Rd @@ -47,7 +47,7 @@ Function allowing to define numeric boundaries for estimation and to define a su reg-arima (tramo) modelling will be performed (pre-processing step) } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). diff --git a/man/set_outlier.Rd b/man/set_outlier.Rd index eb39b31..c2581fd 100644 --- a/man/set_outlier.Rd +++ b/man/set_outlier.Rd @@ -58,7 +58,7 @@ Function allowing to customize the automatic outlier detection process built in in the pre-processing step (regarima or tramo) } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). diff --git a/man/set_tradingdays.Rd b/man/set_tradingdays.Rd index 90aa08f..0cc5e5e 100644 --- a/man/set_tradingdays.Rd +++ b/man/set_tradingdays.Rd @@ -90,7 +90,7 @@ All the built-in regressors are meant to correct for type of day effect but don't take into account any holiday. To do so user-defined regressors have to be built. } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). @@ -98,7 +98,7 @@ generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" gene \examples{ # Pre-defined regressors # y_raw<-ABS$X0.2.09.10.M -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<-set_tradingdays(init_spec, # option = "TD4", # test = "None", @@ -124,7 +124,7 @@ fixed_day(7,21), ## put into a context my_context<-modelling_context(calendars = list(cal=BE)) ## create a specification -#init_spec <- rjd3x13::spec_x13("RSA5c") +#init_spec <- rjd3x13::x13_spec("RSA5c") ## modify the specification # new_spec<-set_tradingdays(init_spec, # option = "TradingDays", calendar.name="cal") @@ -132,7 +132,7 @@ my_context<-modelling_context(calendars = list(cal=BE)) # sa<-rjd3x13::x13(y_raw,new_spec, context=my_context) # User-defined regressors -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # add regressors to context # variables<-list(Monday,Tuesday, Wednesday, # Thursday, Friday, Saturday) diff --git a/man/set_transform.Rd b/man/set_transform.Rd index 5a4c65c..0d17928 100644 --- a/man/set_transform.Rd +++ b/man/set_transform.Rd @@ -37,13 +37,13 @@ Considered only when \code{fun = "Auto"}.} Set Log-level Transformation and Decomposition scheme in Pre-Processing Specification } \details{ -\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::spec_x13()} +\code{x} specification param must be a JD3_X13_SPEC" class object generated with \code{rjd3x13::x13_spec()} (or "JD3_REGARIMA_SPEC" generated with \code{rjd3x13::spec_regarima()} or "JD3_TRAMOSEATS_SPEC" generated with \code{rjd3tramoseats::spec_tramoseats()} or "JD3_TRAMO_SPEC" generated with \code{rjd3tramoseats::spec_tramo()}). } \examples{ -# init_spec <- rjd3x13::spec_x13("RSA5c") +# init_spec <- rjd3x13::x13_spec("RSA5c") # new_spec<- set_transform(init_spec, # fun = "Log", # outliers = TRUE)