From 574cc3c3eda1c30764b2f1443faa6d08fe31c034 Mon Sep 17 00:00:00 2001 From: Tanguy BARTHELEMY Date: Mon, 6 May 2024 11:48:53 +0200 Subject: [PATCH 1/2] change rjdemetra3 --> rjd3workspace and rjdemetra --> rjdverse --- DESCRIPTION | 14 +++++----- NEWS.md | 4 +-- R/deprecated.R | 16 +++++------ R/saitem.R | 2 +- R/saprocessing.R | 2 +- R/workspace.R | 2 +- R/zzz.R | 6 ++--- README.Rmd | 36 ++++++++++++------------- README.md | 32 +++++++++++----------- man/deprecated-rjdemetra3.Rd | 4 +-- man/read_workspace.Rd | 2 +- man/set_ts_metadata.Rd | 2 +- RJDemetra3.Rproj => rjd3workspace.Rproj | 0 13 files changed, 61 insertions(+), 61 deletions(-) rename RJDemetra3.Rproj => rjd3workspace.Rproj (100%) diff --git a/DESCRIPTION b/DESCRIPTION index dfa8f7a..0dff386 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,4 +1,4 @@ -Package: rjdemetra3 +Package: rjd3workspace Type: Package Title: Interface to 'JDemetra+ 3.0' Seasonal Adjustment Software Version: 3.2.3 @@ -24,14 +24,14 @@ Imports: rjd3x13 (>= 3.2.2), rjd3providers (>= 3.2.2) Remotes: - github::rjdemetra/rjd3toolkit, - github::rjdemetra/rjd3tramoseats, - github::rjdemetra/rjd3x13, - github::rjdemetra/rjd3providers + github::rjdverse/rjd3toolkit, + github::rjdverse/rjd3tramoseats, + github::rjdverse/rjd3x13, + github::rjdverse/rjd3providers SystemRequirements: Java (>= 17) License: EUPL -URL: https://github.com/rjdemetra/rjdemetra3, https://rjdemetra.github.io/rjdemetra3/ -BugReports: https://github.com/rjdemetra/rjdemetra3/issues +URL: https://github.com/rjdverse/rjd3workspace, https://rjdverse.github.io/rjd3workspace/ +BugReports: https://github.com/rjdverse/rjd3workspace/issues Suggests: knitr, rmarkdown, diff --git a/NEWS.md b/NEWS.md index 7732bd4..5226247 100644 --- a/NEWS.md +++ b/NEWS.md @@ -9,5 +9,5 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [3.2.2] - 2024-03-15 -[Unreleased]: https://github.com/rjdemetra/rjdemetra3/compare/v3.2.2...HEAD -[3.2.2]: https://github.com/rjdemetra/rjdemetra3/releases/tag/v3.2.2 +[Unreleased]: https://github.com/rjdverse/rjd3workspace/compare/v3.2.2...HEAD +[3.2.2]: https://github.com/rjdverse/rjd3workspace/releases/tag/v3.2.2 diff --git a/R/deprecated.R b/R/deprecated.R index d63ff5e..7050e96 100644 --- a/R/deprecated.R +++ b/R/deprecated.R @@ -2,7 +2,7 @@ #' #' #' @param jmp,idx,jws,name Parameters. -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jmp_sa_count<-function(jmp){ .Deprecated(".jsap_sa_count") @@ -10,45 +10,45 @@ } -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jmp_name<-function(jmp){ .Deprecated(".jsap_name") .jsap_name(jmp) } -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jmp_sa<-function(jmp, idx){ .Deprecated(".jsap_sa") .jsap_sa(jmp, idx) } -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jmp_sa_name <- function(jmp) { .Deprecated(".jsap_sa_name") .jsap_sa_name(jmp) } -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jmp_load<-function(jmp){ .Deprecated("read_sap") read_sap(jmp) } -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jws_multiprocessing<-function(jws, idx){ .Deprecated(".jws_sap") .jws_sap(jws, idx) } -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jws_multiprocessing_new<-function(jws, name){ .Deprecated(".jws_sap_new") .jws_sap_new(jws, name) } -#' @name deprecated-rjdemetra3 +#' @name deprecated-rjd3workspace #' @export .jws_multiprocessing_count<-function(jws){ .Deprecated(".jws_sap_count") diff --git a/R/saitem.R b/R/saitem.R index 83874ef..485a79c 100644 --- a/R/saitem.R +++ b/R/saitem.R @@ -20,7 +20,7 @@ NULL #' - `results`: the result of the model. #' @export .jsa_read<-function(jsa){ -# if(! .jcall(jsa, "Z", "isProcessed")) +# if (! .jcall(jsa, "Z", "isProcessed")) # stop("You must run '.jws_compute()' on your workspace.") jdef<-.jcall(jsa, "Ljdplus/sa/base/api/SaDefinition;", "getDefinition") diff --git a/R/saprocessing.R b/R/saprocessing.R index 706f371..a7a370e 100644 --- a/R/saprocessing.R +++ b/R/saprocessing.R @@ -416,7 +416,7 @@ set_name <- function(jsap, idx, name) { #' @export #' @examples #' # Change the file of a given item -#' file <- system.file("workspaces", "test.xml", package = "rjdemetra3") +#' file <- system.file("workspaces", "test.xml", package = "rjd3workspace") #' jws <- .jws_load(file) #' jsap <- .jws_sap(jws, 1) #' jsa <- .jsap_sa(jsap, 1) diff --git a/R/workspace.R b/R/workspace.R index 1a4fc23..85ef0ea 100644 --- a/R/workspace.R +++ b/R/workspace.R @@ -199,7 +199,7 @@ get_context<-function(jws){ #' #' @export #' @examples -#' file<-system.file("workspaces", "test.xml", package = "rjdemetra3") +#' file<-system.file("workspaces", "test.xml", package = "rjd3workspace") #' jws<-.jws_load(file) #' # We don't compute the workspace #' rws<-read_workspace(jws, FALSE) diff --git a/R/zzz.R b/R/zzz.R index c8117a5..20be472 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -3,9 +3,9 @@ NULL .onLoad <- function(libname, pkgname) { - if (! requireNamespace("rjd3tramoseats", quietly = TRUE)) stop("Loading rjd3 libraries failed") - if (! requireNamespace("rjd3x13", quietly = TRUE)) stop("Loading rjd3 libraries failed") - if (! requireNamespace("rjd3providers", quietly = TRUE)) stop("Loading rjd3 libraries failed") + if (!requireNamespace("rjd3tramoseats", quietly = TRUE)) stop("Loading rjd3 libraries failed") + if (!requireNamespace("rjd3x13", quietly = TRUE)) stop("Loading rjd3 libraries failed") + if (!requireNamespace("rjd3providers", quietly = TRUE)) stop("Loading rjd3 libraries failed") result <- rJava::.jpackage(pkgname, lib.loc=libname) if (!result) stop("Loading java packages failed") diff --git a/README.Rmd b/README.Rmd index 54336c9..d55b4c6 100644 --- a/README.Rmd +++ b/README.Rmd @@ -11,48 +11,48 @@ knitr::opts_chunk$set( fig.path = "man/figures/README-", fig.align="center" ) -library("rjdemetra3") +library("rjd3workspace") ``` -# rjdemetra3 +# rjd3workspace -**rjdemetra3** offers several functions to interact with JDemetra+ v3.0 workspaces. -Seasonal adjustment with X-12ARIMA can be done with the package [**rjd3x13**](https://github.com/rjdemetra/rjd3x13) and with TRAMO-SEATS with the package [**rjd3tramoseats**](https://github.com/rjdemetra/rjd3tramoseats). +**rjd3workspace** offers several functions to interact with JDemetra+ v3.0 workspaces. +Seasonal adjustment with X-12ARIMA can be done with the package [**rjd3x13**](https://github.com/rjdverse/rjd3x13) and with TRAMO-SEATS with the package [**rjd3tramoseats**](https://github.com/rjdverse/rjd3tramoseats). ## 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). -**rjdemetra3** relies on the [**rJava**](https://CRAN.R-project.org/package=rJava) package and Java SE 17 or later version is required. +**rjd3workspace** relies on the [**rJava**](https://CRAN.R-project.org/package=rJava) package and Java SE 17 or later version is required. To get the current stable version (from the latest release): ```{r, eval = FALSE} # install.packages -remotes::install_github("rjdemetra/rjd3toolkit@*release") -remotes::install_github("rjdemetra/rjd3tramoseats@*release") -remotes::install_github("rjdemetra/rjd3x13@*release") -remotes::install_github("rjdemetra/rjd3providers@*release") -remotes::install_github("rjdemetra/rjdemetra3@*release") +remotes::install_github("rjdverse/rjd3toolkit@*release") +remotes::install_github("rjdverse/rjd3tramoseats@*release") +remotes::install_github("rjdverse/rjd3x13@*release") +remotes::install_github("rjdverse/rjd3providers@*release") +remotes::install_github("rjdverse/rjd3workspace@*release") ``` To get the current development version from GitHub: ```{r, eval = FALSE} # install.packages("remotes") -remotes::install_github("rjdemetra/rjdemetra3") +remotes::install_github("rjdverse/rjd3workspace") ``` ## Usage -**rjdemetra3** relies on the [**rJava**](https://CRAN.R-project.org/package=rJava) package and Java SE 17 or later version is required. +**rjd3workspace** relies on the [**rJava**](https://CRAN.R-project.org/package=rJava) package and Java SE 17 or later version is required. ```{r, echo = TRUE, eval = TRUE} -library("rjdemetra3") +library("rjd3workspace") dir <- tempdir() @@ -76,7 +76,7 @@ mod1 <- .jsa_read(jsa1) ``` {r create_sa_item_path, echo = TRUE, eval = TRUE} # install.packages("remotes") -# remotes::install_github("rjdemetra/rjd3providers") +# remotes::install_github("rjdverse/rjd3providers") dir <- tempdir() @@ -87,9 +87,9 @@ y <- ts1$data jws <- .jws_new() jsap1 <- .jws_sap_new(jws, "sa1") add_sa_item(jsap1, name = "x13", x = rjd3x13::x13(y)) -rjdemetra3::set_ts(jsap = jsap1, idx = 1L, y = ts1) +rjd3workspace::set_ts(jsap = jsap1, idx = 1L, y = ts1) add_sa_item(jsap1, name = "tramo", x = rjd3tramoseats::tramoseats(y)) -rjdemetra3::set_ts(jsap = jsap1, idx = 2L, y = ts1) +rjd3workspace::set_ts(jsap = jsap1, idx = 2L, y = ts1) save_workspace(jws, file.path(dir, "ws.xml")) @@ -110,4 +110,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 bc54cc1..06d9851 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -# rjdemetra3 +# rjd3workspace -**rjdemetra3** offers several functions to interact with JDemetra+ v3.0 +**rjd3workspace** offers several functions to interact with JDemetra+ v3.0 workspaces. Seasonal adjustment with X-12ARIMA can be done with the -package [**rjd3x13**](https://github.com/rjdemetra/rjd3x13) and with +package [**rjd3x13**](https://github.com/rjdverse/rjd3x13) and with TRAMO-SEATS with the package -[**rjd3tramoseats**](https://github.com/rjdemetra/rjd3tramoseats). +[**rjd3tramoseats**](https://github.com/rjdverse/rjd3tramoseats). ## Installation -**rjdemetra3** relies on the +**rjd3workspace** relies on the [**rJava**](https://CRAN.R-project.org/package=rJava) package and Java SE 17 or later version is required. @@ -19,28 +19,28 @@ To get the current stable version (from the latest release): ``` r # install.packages -remotes::install_github("rjdemetra/rjd3toolkit@*release") -remotes::install_github("rjdemetra/rjd3tramoseats@*release") -remotes::install_github("rjdemetra/rjd3x13@*release") -remotes::install_github("rjdemetra/rjd3providers@*release") -remotes::install_github("rjdemetra/rjdemetra3@*release") +remotes::install_github("rjdverse/rjd3toolkit@*release") +remotes::install_github("rjdverse/rjd3tramoseats@*release") +remotes::install_github("rjdverse/rjd3x13@*release") +remotes::install_github("rjdverse/rjd3providers@*release") +remotes::install_github("rjdverse/rjd3workspace@*release") ``` To get the current development version from GitHub: ``` r # install.packages("remotes") -remotes::install_github("rjdemetra/rjdemetra3") +remotes::install_github("rjdverse/rjd3workspace") ``` ## Usage -**rjdemetra3** relies on the +**rjd3workspace** relies on the [**rJava**](https://CRAN.R-project.org/package=rJava) package and Java SE 17 or later version is required. ``` r -library("rjdemetra3") +library("rjd3workspace") dir <- tempdir() @@ -64,7 +64,7 @@ mod1 <- .jsa_read(jsa1) ``` r # install.packages("remotes") -# remotes::install_github("rjdemetra/rjd3providers") +# remotes::install_github("rjdverse/rjd3providers") dir <- tempdir() @@ -75,9 +75,9 @@ y <- ts1$data jws <- .jws_new() jsap1 <- .jws_sap_new(jws, "sa1") add_sa_item(jsap1, name = "x13", x = rjd3x13::x13(y)) -rjdemetra3::set_ts(jsap = jsap1, idx = 1L, y = ts1) +rjd3workspace::set_ts(jsap = jsap1, idx = 1L, y = ts1) add_sa_item(jsap1, name = "tramo", x = rjd3tramoseats::tramoseats(y)) -rjdemetra3::set_ts(jsap = jsap1, idx = 2L, y = ts1) +rjd3workspace::set_ts(jsap = jsap1, idx = 2L, y = ts1) save_workspace(jws, file.path(dir, "ws.xml")) diff --git a/man/deprecated-rjdemetra3.Rd b/man/deprecated-rjdemetra3.Rd index cf6248c..85864c0 100644 --- a/man/deprecated-rjdemetra3.Rd +++ b/man/deprecated-rjdemetra3.Rd @@ -1,7 +1,7 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/deprecated.R -\name{deprecated-rjdemetra3} -\alias{deprecated-rjdemetra3} +\name{deprecated-rjd3workspace} +\alias{deprecated-rjd3workspace} \alias{.jmp_sa_count} \alias{.jmp_name} \alias{.jmp_sa} diff --git a/man/read_workspace.Rd b/man/read_workspace.Rd index e42341c..7326fe6 100644 --- a/man/read_workspace.Rd +++ b/man/read_workspace.Rd @@ -21,7 +21,7 @@ Functions to read all the SAItem of a SAProcessing (\code{read_sap()}) or a workspace (\code{read_workspace()}). } \examples{ -file<-system.file("workspaces", "test.xml", package = "rjdemetra3") +file<-system.file("workspaces", "test.xml", package = "rjd3workspace") jws<-.jws_load(file) # We don't compute the workspace rws<-read_workspace(jws, FALSE) diff --git a/man/set_ts_metadata.Rd b/man/set_ts_metadata.Rd index 82ac09b..cc3b949 100644 --- a/man/set_ts_metadata.Rd +++ b/man/set_ts_metadata.Rd @@ -27,7 +27,7 @@ allows to update a specific key with a new information. } \examples{ # Change the file of a given item -file <- system.file("workspaces", "test.xml", package = "rjdemetra3") +file <- system.file("workspaces", "test.xml", package = "rjd3workspace") jws <- .jws_load(file) jsap <- .jws_sap(jws, 1) jsa <- .jsap_sa(jsap, 1) diff --git a/RJDemetra3.Rproj b/rjd3workspace.Rproj similarity index 100% rename from RJDemetra3.Rproj rename to rjd3workspace.Rproj From fee19cd8e2a30e2e0462029a2b5f0fdefab573ae Mon Sep 17 00:00:00 2001 From: Tanguy BARTHELEMY Date: Mon, 6 May 2024 14:12:32 +0200 Subject: [PATCH 2/2] change rjdemetra3 --> rjd3workspace and rjdemetra --> rjdverse --- README.html | 684 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 11 +- 2 files changed, 692 insertions(+), 3 deletions(-) create mode 100644 README.html diff --git a/README.html b/README.html new file mode 100644 index 0000000..be61ffb --- /dev/null +++ b/README.html @@ -0,0 +1,684 @@ + + + + + + + + + + + + + + + + + + + + + +

rjd3workspace

+

rjd3workspace offers several functions to interact +with JDemetra+ v3.0 workspaces. Seasonal adjustment with X-12ARIMA can +be done with the package rjd3x13 +and with TRAMO-SEATS with the package rjd3tramoseats.

+

Installation

+

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

+

rjd3workspace relies on the rJava +package and Java SE 17 or later version is required.

+

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

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

To get the current development version from GitHub:

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

Usage

+

rjd3workspace relies on the rJava +package and Java SE 17 or later version is required.

+
library("rjd3workspace")
+
+dir <- tempdir()
+
+y <- rjd3toolkit::ABS$X0.2.09.10.M
+jws <- .jws_new()
+jsap1 <- .jws_sap_new(jws, "sa1")
+add_sa_item(jsap1, name = "x13", x = rjd3x13::x13(y))
+add_sa_item(jsap1, name = "tramo", x = rjd3tramoseats::tramoseats(y))
+save_workspace(jws, file.path(dir, "ws.xml"))
+
+jws <- .jws_load(file = file.path(dir, "ws.xml"))
+.jws_compute(jws) # to compute the models
+jsap1 <- .jws_sap(jws, idx = 1) # first SAProcessing
+jsa1 <- .jsap_sa(jsap1, idx = 1) # first SAItem
+.jsa_name(jsa1)
+#> [1] "x13"
+mod1 <- .jsa_read(jsa1)
+

Create SA-item with path

+
# install.packages("remotes")
+# remotes::install_github("rjdverse/rjd3providers")
+
+dir <- tempdir()
+
+xlsx_file <- paste0(system.file("examples", package="rjd3providers"), "/Insee.xlsx")
+ts1 <- rjd3providers::spreadsheet_series(file = xlsx_file, sheet = 1L, series = 3L)
+
+y <- ts1$data
+jws <- .jws_new()
+jsap1 <- .jws_sap_new(jws, "sa1")
+add_sa_item(jsap1, name = "x13", x = rjd3x13::x13(y))
+rjd3workspace::set_ts(jsap = jsap1, idx = 1L, y = ts1)
+add_sa_item(jsap1, name = "tramo", x = rjd3tramoseats::tramoseats(y))
+rjd3workspace::set_ts(jsap = jsap1, idx = 2L, y = ts1)
+
+save_workspace(jws, file.path(dir, "ws.xml"))
+
+jws <- .jws_load(file = file.path(dir, "ws.xml"))
+.jws_compute(jws) # to compute the models
+jsap1 <- .jws_sap(jws, idx = 1) # first SAProcessing
+jsa1 <- .jsap_sa(jsap1, idx = 1) # first SAItem
+.jsa_name(jsa1)
+#> [1] "x13"
+mod1 <- .jsa_read(jsa1)
+

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/README.md b/README.md index 06d9851..0bae62b 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,18 @@ # rjd3workspace -**rjd3workspace** offers several functions to interact with JDemetra+ v3.0 -workspaces. Seasonal adjustment with X-12ARIMA can be done with the +**rjd3workspace** offers several functions to interact with JDemetra+ +v3.0 workspaces. Seasonal adjustment with X-12ARIMA can be done with the package [**rjd3x13**](https://github.com/rjdverse/rjd3x13) and with TRAMO-SEATS with the package [**rjd3tramoseats**](https://github.com/rjdverse/rjd3tramoseats). ## 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). + **rjd3workspace** relies on the [**rJava**](https://CRAN.R-project.org/package=rJava) package and Java SE 17 or later version is required. @@ -100,4 +104,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).