diff --git a/NEWS.md b/NEWS.md index d317b00..995777c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -9,6 +9,6 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [3.2.2] - 2024-03-15 -[Unreleased]: https://github.com/rjdemetra/rjd3x13/compare/v3.2.2...HEAD -[3.2.2]: https://github.com/rjdemetra/rjd3x13/releases/tag/v3.2.2 +[Unreleased]: https://github.com/rjdverse/rjd3x13/compare/v3.2.2...HEAD +[3.2.2]: https://github.com/rjdverse/rjd3x13/releases/tag/v3.2.2 diff --git a/R/zzz.R b/R/zzz.R index 564d97c..98b6f17 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -5,7 +5,7 @@ .onLoad <- function(libname, pkgname) { - if (! requireNamespace("rjd3toolkit", quietly = TRUE)) stop("Loading rjd3 libraries failed") + if (!requireNamespace("rjd3toolkit", quietly = TRUE)) stop("Loading rjd3 libraries failed") result <- .jpackage(pkgname, lib.loc=libname) if (!result) stop("Loading java packages failed") diff --git a/README.Rmd b/README.Rmd index 9d4eec3..44bc104 100644 --- a/README.Rmd +++ b/README.Rmd @@ -67,4 +67,4 @@ pull requests should include **updated tests** and **updated documentation**. If ## Licensing -The code of this project is licensed under the [European Union Public Licence (EUPL)](https://joinup.ec.europa.eu/page/eupl-text-11-12). +The code of this project is licensed under the [European Union Public Licence (EUPL)](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12). diff --git a/README.html b/README.html new file mode 100644 index 0000000..bdef1e3 --- /dev/null +++ b/README.html @@ -0,0 +1,687 @@ + + + + +
+ + + + + + + + + + + + + + + + +rjd3x13 offers full access to options and outputs of X-13
+(rjd3x13::x13()
), including RegARIMA modelling
+(rjd3x13::regarima()
) and X-11 decomposition
+(rjd3x13::x11()
).
A specification can be created with
+rjd3x13::regarima_spec()
, rjd3x13::x11_spec()
+or rjd3x13::x13_spec()
and can be modified with the
+following functions:
for pre-processing: rjd3toolkit::set_arima()
,
+rjd3toolkit::set_automodel()
,
+rjd3toolkit::set_basic()
,
+rjd3toolkit::set_easter()
,
+rjd3toolkit::set_estimate()
,
+rjd3toolkit::set_outlier()
,
+rjd3toolkit::set_tradingdays()
,
+rjd3toolkit::set_transform()
,
+rjd3toolkit::add_outlier()
,
+rjd3toolkit::remove_outlier()
,
+rjd3toolkit::add_ramp()
,
+rjd3toolkit::remove_ramp()
,
+rjd3toolkit::add_usrdefvar()
;
for decomposition: rjd3x13::set_x11()
;
for benchmarking:
+rjd3toolkit::set_benchmarking()
.
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):
+ +To get the current development version from GitHub:
+ +library("rjd3x13")
+
+y <- rjd3toolkit::ABS$X0.2.09.10.M
+x13_model <- x13(y)
+summary(x13_model$result$preprocessing) # Summary of regarima model
+#> Log-transformation: yes
+#> SARIMA model: (2,1,1) (0,1,1)
+#>
+#> Coefficients
+#> Estimate Std. Error T-stat Pr(>|t|)
+#> phi(1) 0.34740 0.06502 5.343 1.53e-07 ***
+#> phi(2) 0.21733 0.06000 3.622 0.000329 ***
+#> theta(1) -0.69937 0.05115 -13.672 < 2e-16 ***
+#> btheta(1) -0.48038 0.06993 -6.869 2.45e-11 ***
+#> ---
+#> Signif. codes: 0 '***' 0.001 '**' 0.01 '*' 0.05 '.' 0.1 ' ' 1
+#>
+#> Regression model:
+#> Estimate Std. Error T-stat Pr(>|t|)
+#> td 0.0023233 0.0006844 3.395 0.000755 ***
+#> easter 0.0520113 0.0084894 6.127 2.13e-09 ***
+#> TC (2000-06-01) 0.1590340 0.0288578 5.511 6.37e-08 ***
+#> AO (2000-07-01) -0.2900774 0.0400551 -7.242 2.25e-12 ***
+#> ---
+#> Signif. codes: 0 '***' 0.001 '**' 0.01 '*' 0.05 '.' 0.1 ' ' 1
+#> Number of observations: 425 , Number of effective observations: 412 , Number of parameters: 9
+#> Loglikelihood: 746.7517, Adjusted loglikelihood: -2120.875
+#> Standard error of the regression (ML estimate): 0.03927991
+#> AIC: 4259.75 , AICc: 4260.198 , BIC: 4295.939
+
+plot(x13_model) # Plot of the final decomposition
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.
+The code of this project is licensed under the European +Union Public Licence (EUPL).
+ + + diff --git a/README.md b/README.md index 8086ec6..74cf5e1 100644 --- a/README.md +++ b/README.md @@ -91,4 +91,5 @@ should be added or updated. ## Licensing The code of this project is licensed under the [European Union Public -Licence (EUPL)](https://joinup.ec.europa.eu/page/eupl-text-11-12). +Licence +(EUPL)](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12). diff --git a/_pkgdown.yml b/_pkgdown.yml index 59bef83..ab1ff86 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,4 +1,4 @@ -url: https://rjdemetra.github.io/rjd3x13/ +url: https://rjdverse.github.io/rjd3x13/ template: bootstrap: 5