https://github.com/rjdverse/rjd3tramoseats
R access to Tramo-Seats algorithm in JDemetra+ version 3.x
https://github.com/rjdverse/rjd3tramoseats
java jdemetra r r-package rstats seasonal-adjustment time-series timeseries tramoseats
Last synced: 4 months ago
JSON representation
R access to Tramo-Seats algorithm in JDemetra+ version 3.x
- Host: GitHub
- URL: https://github.com/rjdverse/rjd3tramoseats
- Owner: rjdverse
- License: eupl-1.2
- Created: 2023-06-14T09:59:09.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2026-01-28T16:17:13.000Z (5 months ago)
- Last Synced: 2026-01-29T07:20:18.906Z (5 months ago)
- Topics: java, jdemetra, r, r-package, rstats, seasonal-adjustment, time-series, timeseries, tramoseats
- Language: R
- Homepage: https://rjdverse.github.io/rjd3tramoseats/
- Size: 10.8 MB
- Stars: 6
- Watchers: 4
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
```{r, echo = FALSE, include=FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
fig.align = "center",
fig.width = 8L
)
library("rjd3tramoseats")
```
# {rjd3tramoseats} 
[](https://cran.r-project.org/package=rjd3tramoseats)
[](https://github.com/SNStatComp/awesome-official-statistics-software)
[](https://github.com/rjdverse/rjd3tramoseats/actions/workflows/R-CMD-check.yaml)
[](https://github.com/rjdverse/rjd3tramoseats/actions/workflows/lint.yaml)
[](https://github.com/rjdverse/rjd3tramoseats/actions/workflows/pkgdown.yaml)
{rjd3tramoseats} offers full access to options and outputs of TRAMO-SEATS (`rjd3tramoseats::tramoseats()`), including TRAMO modelling (`rjd3tramoseats::tramo()`) and SEATS decomposition (`rjd3tramoseats::seats_decompose()`).
A specification can be created with `rjd3tramoseats::tramo_spec()` or `rjd3tramoseats::tramoseats_spec()` and can be modified with the following functions:
- for pre-processing: `rjd3tramoseats::set_arima()`, `rjd3tramoseats::set_automodel()`, `rjd3tramoseats::set_basic()`, `rjd3tramoseats::set_easter()`, `rjd3tramoseats::set_estimate()`, `rjd3tramoseats::set_outlier()`, `rjd3tramoseats::set_tradingdays()`, `rjd3tramoseats::set_transform()`, `rjd3tramoseats::add_outlier()`, `rjd3tramoseats::remove_outlier()`, `rjd3tramoseats::add_ramp()`, `rjd3tramoseats::remove_ramp()`, `rjd3tramoseats::add_usrdefvar()`;
- for decomposition: `rjd3tramoseats::set_seats()`;
- for benchmarking: `rjd3toolkit::set_benchmarking()`.
## 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/#Rconfig)
### Latest release
To get the current stable version (from the latest release):
- From GitHub:
```{r, echo = TRUE, eval = FALSE}
# install.packages("remotes")
remotes::install_github("rjdverse/rjd3toolkit@*release")
remotes::install_github("rjdverse/rjd3tramoseats@*release")
```
- From [r-universe](https://rjdverse.r-universe.dev/rjd3tramoseats):
```{r, echo = TRUE, eval = FALSE}
install.packages("rjd3tramoseats", repos = c("https://rjdverse.r-universe.dev", "https://cloud.r-project.org"))
```
### Development version
You can install the development version of **{rjd3tramoseats}** from [GitHub](https://github.com/) with:
```{r, echo = TRUE, eval = FALSE}
# install.packages("remotes")
remotes::install_github("rjdverse/rjd3tramoseats")
```
## Usage
```{r ts-final}
library("rjd3tramoseats")
y <- rjd3toolkit::ABS$X0.2.09.10.M
ts_model <- tramoseats(y)
summary(ts_model$result$preprocessing) # Summary of tramo model
plot(ts_model) # Plot of the final decomposition
```
To get the final components you can use the function `rjd3toolkit::sa_decomposition()`:
```{r ts-fin-comp}
rjd3toolkit::sa_decomposition(ts_model)
```
## 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)](https://interoperable-europe.ec.europa.eu:443/collection/eupl/eupl-text-eupl-12).