new policies

Author: AQLT

NEWS.md

@@ -6,6 +6,8 @@
 
 - parameter `file_param` added in `create_param_file()` and `list2param_file()` to be able to change the name of the parameter file.
 
+- documentation update to add new policies.
+
 # rjwsacruncher 0.2.0
 
 - correction in export of the log file when relative path are given.

R/param_file.R

@@ -25,6 +25,7 @@
 #' \item \code{policy = "current"}: all the estimations are fixed and AO added for new data (since v.2.2.3), short name `policy = "n"`;
 #' \item \code{policy = "fixed"}: all the estimations are fixed (since v.2.2.3), short name `policy = "f"`;
 #' \item \code{policy = "fixedparameters"}: re-estimation of the coefficients of the regression variables (but not the ARIMA coefficients), short name `policy = "fp"`;
+#' \item \code{policy = "fixedarparameters"}: re-estimation of the coefficients of the regression variables and of the MA coefficients of the ARIMA model (but not the AR coefficients), short name `policy = "farp"` (since v.3.3.1);
 #' \item \code{policy = "parameters"} (the default): \code{policy = "fixedparameters"} + re-estimation of ARIMA coefficients, short name `policy = "p"`;
 #' \item \code{policy = "lastoutliers"}: \code{policy = "parameters"} + re-identification of last outliers (on the last year), short name `policy = "l"`;
 #' \item \code{policy = "outliers"}: \code{policy = "lastoutliers"} + re-identification of all outliers, short name `policy = "o"`;

README.Rmd

@@ -31,12 +31,15 @@ The goal of rjwsacruncher is to launch quickly and easily the [JWSACruncher](htt
 # Install release version from CRAN
 install.packages("rjwsacruncher")
 
-# Install development version from GitHub
+# Install development version:
+install.packages("rjwsacruncher", repos = c("https://aqlt.r-universe.dev", "https://cloud.r-project.org"))
+# Or :
 # install.packages("devtools")
-devtools::install_github("AQLT/rjwsacruncher")
+# devtools::install_github("AQLT/rjwsacruncher")
 ```
 
-The JWSACruncher is not included in the package. It can be downloaded from GitHub (<https://github.com/jdemetra/jwsacruncher/releases>) or with the function `download_cruncher()`:
+The JWSACruncher is not included in the package. 
+It can be downloaded from GitHub (<https://github.com/jdemetra/jwsacruncher/releases> or <https://github.com/jdemetra/jdplus-main/releases>) or with the function `download_cruncher()`:
 
 ```{r, eval = FALSE}
 library(rjwsacruncher)

README.md

@@ -26,14 +26,17 @@ JWSACruncher can be found on
 # Install release version from CRAN
 install.packages("rjwsacruncher")
 
-# Install development version from GitHub
+# Install development version:
+install.packages("rjwsacruncher", repos = c("https://aqlt.r-universe.dev", "https://cloud.r-project.org"))
+# Or :
 # install.packages("devtools")
-devtools::install_github("AQLT/rjwsacruncher")
+# devtools::install_github("AQLT/rjwsacruncher")
 ```
 
 The JWSACruncher is not included in the package. It can be downloaded
-from GitHub (<https://github.com/jdemetra/jwsacruncher/releases>) or
-with the function `download_cruncher()`:
+from GitHub (<https://github.com/jdemetra/jwsacruncher/releases> or
+<https://github.com/jdemetra/jdplus-main/releases>) or with the function
+`download_cruncher()`:
 
 ``` r
 library(rjwsacruncher)
@@ -67,14 +70,8 @@ and “default_tsmatrix_series”:
 head(getOption("default_matrix_item"))
 #> [1] "period"       "span.start"   "span.end"     "span.n"       "span.missing"
 #> [6] "espan.start"
-```
-
-``` r
 getOption("default_tsmatrix_series")
 #> [1] "y"    "t"    "sa"   "s"    "i"    "ycal"
-```
-
-``` r
 # To only export the seasonally adjusted series and its forecasts:
 options(default_tsmatrix_series = c("sa", "sa_f"))
 ```

man/create_param_file.Rd

@@ -1,4 +1,5 @@
 Version: 1.0
+ProjectId: 47355459-5488-4634-962b-f72f4a2fe071
 
 RestoreWorkspace: Default
 SaveWorkspace: Default

rjwsacruncher.Rproj

@@ -21,7 +21,7 @@ library(rjwsacruncher)
 # Launch the 'JWSACruncher"
 
 To use `rjwsacruncher` you need to download the JWACruncher. 
-It is available on <https://github.com/jdemetra/jdemetra-app/releases> (for JDemetra+ 2.x.y versions) or <https://github.com/jdemetra/jdemetra-app/releases> (for JDemetra+ 3.x.y versions).
+It is available on <https://github.com/jdemetra/jdemetra-app/releases> (for JDemetra+ 2.x.y versions) or <https://github.com/jdemetra/jdplus-main/releases> (for JDemetra+ 3.x.y versions).
 It can also be downloaded with the function `download_cruncher()`:
 ```{r, eval = FALSE}
 library(rjwsacruncher)
@@ -56,36 +56,37 @@ The three most important parameters of `create_param_file()` are:
 1. `policy` the refresh policy (see table below).
 
 ```{r,echo=FALSE}
-refresh_policy <- structure(list(`Option on JDemetra+` = c(
+refresh_policy <- data.frame(`Option on JDemetra+` = c(
   "Current[AO]: fixed model + AO for new data",
   "Fixed model", 
 "Estimate regression coefficients", 
+"Estimate regression coefficients + MA parameters of the ARIMA model", 
 "Estimate regression coefficients + Arima parameters", 
 "Estimate regression coefficients + Last outliers", 
 "Estimate regression coefficients + all outliers", 
 "Estimate regression coefficients + Arima model", 
 "Concurrent"), 
 `Option for the JWSACruncher` = c(
-  "current", "fixed", "fixedparameters", 
+  "current", "fixed", "fixedparameters",  "fixedarparameters",
 "parameters (by default)", "lastoutliers", "outliers", 
 "stochastic", "complete (or concurrent)"),
 `Short name` = c(
-  "n", "f", "fp", "p", "l", "o", "s", "c"
+  "n", "f", "fp", "farp", "p", "l", "o", "s", "c"
 ),
 Description = c(
-   "The ARIMA model, outliers and other regression parameters are not re-identified and the values of all parameters are fixed. The transformation type remains unchanged. An additive outlier (AO) is added for new data",
-  "The ARIMA model, outliers and other regression parameters are not re-identified and the values of all parameters are fixed. The transformation type remains unchanged.", 
+   "The ARIMA model, outliers and other regression parameters are not re-identified and the values of all parameters are fixed. The transformation type remains unchanged. An additive outlier (AO) is added for new data. (since v.2.2.3)",
+  "The ARIMA model, outliers and other regression parameters are not re-identified and the values of all parameters are fixed. The transformation type remains unchanged. (since v.2.2.3)", 
 "The ARIMA model, outliers and other regression parameters are not re-identified. The coefficients of the ARIMA model are fixed, other coefficients are re-estimated. The transformation type remains unchanged.", 
+"The ARIMA model, outliers and other regression parameters are not re-identified. The AR coefficients of the ARIMA model are fixed, other coefficients are re-estimated (MA coefficients + regressors). The transformation type remains unchanged. (since v.3.3.1)", 
 "The ARIMA model, outliers and other regression parameters are not re-identified. All parameters of the RegARIMA model are re-estimated. The transformation type remains unchanged.", 
 "The ARIMA model, outliers (except from the outliers in the last year of the sample) and other regression parameters are not re-identified. All parameters of the RegARIMA model are re-estimated. The outliers in the last year of the sample are re-identified. The transformation type remains unchanged.", 
 "The ARIMA model and regression parameters, except from outliers) are not re-identified. All parameters of the RegARIMA model are re-estimated. All outliers are re-identified. The transformation type remains unchanged.", 
 "Re-identification of the ARIMA model, outliers and regression variables, except from the calendar variables. The transformation type remains unchanged.", 
-"Re-identification of the whole RegARIMA model.")),
-.Names = c("Option on JDemetra+", 
-"Option for the JWSACruncher", "Short name", "Description"),
-class = "data.frame", row.names = c(NA, -8L))
+"Re-identification of the whole RegARIMA model."), 
+check.names = FALSE
+)
 
-refresh_policy[2:7, 1] <-  paste("Partial concurrent adjustment ->", refresh_policy[2:7, 1])
+refresh_policy[-c(1, nrow(refresh_policy)), 1] <-  paste("Partial concurrent adjustment ->", refresh_policy[-c(1, nrow(refresh_policy)), 1])
 kable(refresh_policy, caption = "Refresh policies",
       booktabs = TRUE)
 ```