Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

desp file and readme update #37

Merged
merged 1 commit into from
May 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
Package: rjdemetra3
Package: rjd3workspace
Type: Package
Title: Interface to 'JDemetra+ 3.0' Seasonal Adjustment Software
Title: Interface to 'JDemetra+ 3.x' time series analysis software.
Version: 3.2.3
Authors@R: c(
person("Alain", "Quartier-la-Tente", role = c("aut", "cre"),
person("Jean", "Palate", role = c("aut"),
email = "[email protected]"),
person("Alain", "Quartier-la-Tente", role = c("aut"),
email = "[email protected]",
comment = c(ORCID = "0000-0001-7890-3857")),
person("Anna", "Michalek", role = "aut",
email = "[email protected]"),
person("Jean", "Palate", role = "aut",
email = "[email protected]"),
person("Raf", "Baeyens", role = "aut",
email = "[email protected]"))
Description: Interface around 'JDemetra+ 3.x' (<https://github.com/jdemetra/jdemetra-app>).
person("Tanguy", "Barthelemy", role = c("aut","cre"),
email ="[email protected]"),
person("Anna", "Smyk", role = c("aut"),
email ="[email protected]"))
Description: R Interface to 'JDemetra+ 3.x' (<https://github.com/jdemetra>).
It offers several functions to manipulate 'JDemetra+' workspaces, which can be read by the software
and can store several seasonal adjusted series along with user-defined calendars or regression variables.
Depends:
R (>= 3.6.0),
R (>= 4.1.0),
Imports:
rJava (>= 1.0-6),
rjd3toolkit (>= 3.2.2),
rjd3tramoseats (>= 3.2.2),
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,
Expand Down
36 changes: 17 additions & 19 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,48 +11,46 @@ 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 wrangle JDemetra+ v3.x 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

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/#Rconfig)

**rjdemetra3** 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.


```{r, echo = TRUE, eval = TRUE}
library("rjdemetra3")
library("rjd3workspace")

dir <- tempdir()

Expand All @@ -76,7 +74,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()

Expand All @@ -87,9 +85,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"))

Expand Down
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,45 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# rjdemetra3
# rjd3workspace

**rjdemetra3** offers several functions to interact with JDemetra+ v3.0
**rjd3workspace** offers several functions to wrangle JDemetra+ v3.x
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
[**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

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/#Rconfig)

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
[**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()

Expand All @@ -64,7 +63,7 @@ mod1 <- .jsa_read(jsa1)

``` r
# install.packages("remotes")
# remotes::install_github("rjdemetra/rjd3providers")
# remotes::install_github("rjdverse/rjd3providers")

dir <- tempdir()

Expand All @@ -75,9 +74,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"))

Expand Down
Loading