From 0483748b5f6d63d1b322980327008f210831b8f1 Mon Sep 17 00:00:00 2001 From: Tanguy BARTHELEMY Date: Mon, 6 May 2024 11:43:48 +0200 Subject: [PATCH 1/2] update readme with new EUPLE link --- R/zzz.R | 2 +- README.Rmd | 4 ++-- README.md | 7 ++++++- 3 files changed, 9 insertions(+), 4 deletions(-) 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 a87458a..4f0d4ac 100644 --- a/README.Rmd +++ b/README.Rmd @@ -29,7 +29,7 @@ The specification can be created with the functions `rjd3x13::regarima_spec()`, ## Installation -Running rjd3 packages requires Java 17 or higher. How to set up such a configuration in R is explained [here](https://jdemetra-new-documentation.netlify.app/#installing-the-software) +Running rjd3 packages requires Java 17 or higher. How to set up such a configuration in R is explained [here](https://jdemetra-new-documentation.netlify.app/#installing-the-software). To get the current stable version (from the latest release): @@ -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.md b/README.md index bf6bfeb..2f9e4d4 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,10 @@ The specification can be created with the functions ## Installation +Running rjd3 packages requires Java 17 or higher. How to set up such a +configuration in R is explained +[here](https://jdemetra-new-documentation.netlify.app/#installing-the-software). + To get the current stable version (from the latest release): ``` r @@ -87,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). From a3de52fd8e8c1272516f059a2c8b527ed0da7924 Mon Sep 17 00:00:00 2001 From: Tanguy BARTHELEMY Date: Mon, 6 May 2024 14:12:05 +0200 Subject: [PATCH 2/2] change rjdemetra3 --> rjd3workspace and rjdemetra --> rjdverse --- NEWS.md | 4 +- README.html | 687 +++++++++++++++++++++++++++++++++++++++++++++++++++ _pkgdown.yml | 2 +- 3 files changed, 690 insertions(+), 3 deletions(-) create mode 100644 README.html 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/README.html b/README.html new file mode 100644 index 0000000..bdef1e3 --- /dev/null +++ b/README.html @@ -0,0 +1,687 @@ + + + + + + + + + + + + + + + + + + + + + +

rjd3x13

+

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:

+ +

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/rjd3x13@*release")
+

To get the current development version from GitHub:

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

Usage

+
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
+ + +

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/_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