-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
71 lines (54 loc) · 2.56 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "90%"
)
```
# persephone
[](https://travis-ci.org/statistikat/persephone)
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://github.com/statistikat/persephone)
[](https://github.com/statistikat/persephone/commits/master)
[](https://coveralls.io/r/statistikat/persephone?branch=master&service=github)
This package is an object oriented wrapper around the R Package [RJDemetra], which performs
time series adjustments with the java library [JDemetra+]
## Installation
``` r
# install the package from GitHub
devtools::install_github("statistikat/persephone")
# optional: also install vignettes (needs prettydoc)
devtools::install_github("statistikat/persephone", build_vignettes = TRUE)
```
## Usage
Objects can be constructed with `perX13` or `perTramo`. Subseqentually,
the `run` method runs the model and `output` gives access to the output object from
`RJDemetra`.
```{r, message = FALSE}
library(persephone)
obj <- perX13(AirPassengers)
plot(obj)
```
The original output from [RJDemetra] can be inspected via the `output` field.
```{r}
obj$run()
obj$output$regarima
```
## Further reading
More information can be found on the [github-pages site] for persephone.
* An overview of the package is available in the [useR!2019 slides].
* The [plotting vignette] contains examples of interactive plots htat can be
created with `persephone`.
* More information about hierarchical time series can be found in the
[hierarchical timeseries vignette].
[RJDemetra]: https://github.com/nbbrd/rjdemetra
[JDemetra+]: https://github.com/jdemetra
[github-pages site]: https://statistikat.github.io/persephone/
[useR!2019 slides]: https://statistikat.github.io/persephone/articles/persephone-useR.pdf
[plotting vignette]: https://statistikat.github.io/persephone/articles/persephone-plotting.html
[hierarchical timeseries vignette]: https://statistikat.github.io/persephone/articles/persephone-hierarchical.html