-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
99 lines (63 loc) · 3.82 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{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` <a href="https://rjdverse.github.io/rjd3tramoseats/"><img src="man/figures/logo.png" align="right" height="150" style="float:right; height:150px;"/></a>
<!-- badges: start -->
[](https://CRAN.R-project.org/package=rjd3tramoseats)
[](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)
<!-- badges: end -->
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: `rjd3tramoseats::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://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12).