Skip to content

statistikat/persephone3

Repository files navigation

persephone3

Travis-CI Build Status Coverage status

Object oriented wrapper around the seasonal adjustment packages in the rjdverse. The package performs time series adjustments with the java library JDemetra+ and focuses on batch processing, hierarchical time series and analytic charts.

Installation

The following commands install persephone3 as well as the packages from the rjdverse that talk with the java interface.

# install dependencies
remotes::install_github("rjdverse/rjd3toolkit@*release")
remotes::install_github("rjdverse/rjd3x13@*release")
remotes::install_github("rjdverse/rjd3tramoseats@*release")

# install the package from GitHub
remotes::install_github("statistikat/persephone/tree/persephone3")

Usage

Objects can be constructed with perX13() or perTramo(). Subsequently, the run() method runs the model and output gives access to the output object from rjd3x13::x13_fast() or rjd3tramoseats::tramoseats_fast().

library(persephone) #change to persephone3 at some point, still working on some issues
# construct a ts-model object
obj <- perX13(AirPassengers)
# run the model
obj$run()
# access the preprocessing slot of the rjd3 output object
obj$output$preprocessing
#> NULL
# visualize the results 
obj$plot() # change to hchart some time

Further reading

This section still needs an update to persephone3.

More information can be found on the github-pages site for persephone.

About

No description, website, or topics provided.

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages