-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathREADME.Rmd
More file actions
84 lines (52 loc) · 3.31 KB
/
README.Rmd
File metadata and controls
84 lines (52 loc) · 3.31 KB
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
---
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("rjd3x13")
```
# {rjd3x13} <a href="https://rjdverse.github.io/rjd3x13/"><img src="man/figures/logo.png" align="right" height="150" style="float:right; height:150px;"/></a>
<!-- badges: start -->
[](https://cran.r-project.org/package=rjd3x13)
[](https://github.com/SNStatComp/awesome-official-statistics-software)
[](https://github.com/rjdverse/rjd3x13/actions/workflows/R-CMD-check.yaml)
[](https://github.com/rjdverse/rjd3x13/actions/workflows/lint.yaml)
[](https://github.com/rjdverse/rjd3x13/actions/workflows/pkgdown.yaml)
<!-- badges: end -->
{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:
- for pre-processing: `rjd3toolkit::set_arima()`, `rjd3toolkit::set_automodel()`, `rjd3toolkit::set_basic()`, `rjd3toolkit::set_easter()`, `rjd3toolkit::set_estimate()`, `rjd3toolkit::set_outlier()`, `rjd3toolkit::set_tradingdays()`, `rjd3toolkit::set_transform()`, `rjd3toolkit::add_outlier()`, `rjd3toolkit::remove_outlier()`, `rjd3toolkit::add_ramp()`, `rjd3toolkit::remove_ramp()`, `rjd3toolkit::add_usrdefvar()`;
- for decomposition: `rjd3x13::set_x11()`;
- for benchmarking: `rjd3toolkit::set_benchmarking()`.
## Installation
Running rjd3 packages requires **Java 21 or higher**. How to set up such a configuration in R is explained [here](https://jdemetra-new-documentation.netlify.app/#Rconfig)
**🎉 {rjd3x13} is now available on CRAN! 🎉**
To install it, you have to launch the following command line:
```{r, eval = FALSE}
install.packages("rjd3x13")
```
To get the current development version of **{rjd3x13}** from [GitHub](https://github.com/) with:
```{r, echo = TRUE, eval = FALSE}
# install.packages("remotes")
remotes::install_github("rjdverse/rjd3x13")
```
## Usage
```{r x-13-final}
library("rjd3x13")
y <- rjd3toolkit::ABS$X0.2.09.10.M
x13_model <- x13(y)
summary(x13_model$result$preprocessing) # Summary of regarima model
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)](https://interoperable-europe.ec.europa.eu:443/collection/eupl/eupl-text-eupl-12).