christophsax/seasonalview

Graphical User Interface for Seasonal Adjustment

Graphical User Interface for Seasonal Adjustment

An R package that unifies the shiny-based graphical user interfaces from the seasonal and x13story packages and the online adjustment tool on www.seasonal.website.

To install from CRAN, use:

install.packages("seasonalview")

Seasonal

The main function of the package is the view function, which works like the depreciated inspect function in seasonal (which it replaces). seasonalview is imported by seasonal, so loading is not necessary:

library(seasonal)  
m <- seas(AirPassengers)
view(m)

X-13 Story

If you have the x13story package installed, you can call the function with the story argument. This will render an R Markdown document and produce a story on seasonal adjustment that can be manipulated interactively.

view(story = "https://raw.githubusercontent.com/christophsax/x13story/master/inst/stories/x11.Rmd")

Stand-alone

Finally, you can set up a stand-alone seasonal adjustment tool, either locally or on a server. While itself not very useful, the standalone function showcases how a local version of www.seasonal.website would look like:

library(seasonalview)
standalone()

License and Credits

seasonalview is free and open source, licensed under GPL-3. It is built on top of a large number of great open source tools. It uses shiny and shinydashboard. It also uses dygraphs, and, of course, seasonal, x13binary and X-13ARIMA-SEATS, the wonderful seasonal adjustment software by the U.S. Census Bureau.

Thanks for your feedback, your ideas and bug-reports. Contact me.

seasonalview's Issues

`import.spc2` not found

If you want to manually adjust the X-13 spec code...

Warning: Error in observerFunc: could not find function "import.spc2"
Stack trace (innermost first):
    57: observerFunc [/Library/Frameworks/R.framework/Versions/3.3/Resources/library/seasonalview/app/server.R#73]
     2: shiny::runApp
     1: view
ERROR: [on_request_read] connection reset by peer

Warning: 'xts::indexClass' is deprecated.

> view(seas(AirPassengers))
Press ESC (or Ctrl-C) to get back to the R session
Loading required package: shiny
Warning: 'xts::indexClass' is deprecated.
Use 'tclass' instead.

'auto expand' with R and X-13 box is buggy

perhaps turn it off and got back to a scrollable area with fixed height

Significance of tests not visible in view(seas())

The significance of the tests (e.g. test for no seasonality in final series) is sometimes not visible in the shiny interface. For example, summary(seas(x)) shows that H0 is rejected on the 1% level while in view() 1% is written in white color on a white ground, hence it is not visible.
Most likely, the problem is that the box around the "1%" has is of white color as well.

Update CRAN

• R CMD check --as.cran
• Fix GHA
• Windbuilder, Macbuilder (change email address)
• Christoph to release

`x11 = ""` is added at the end of the R call

x <- seas(AirPassengers, x11.seasonalma = "s3x5")
view(x)

an empty x11 = "" is added at the end of the R call box, leading to a
reevaluation of the call.

Use of ACE-editor

Including this for future reference.

The use of the ACE-editor (at least trough shinyAce) slows down website loading time by almost 4 sek on a slow Internet connection). Without some great benefit (e.g. autocompletion) that's not worth the pain.

Bug in view because of variable naming m instead of x

Just found a bug in the view function. Fortunately it's simple to fix:
You use x as a parameter, but continue to use m below the story part. Your example work fine cause you use m and because of R's scoping m is found here.

https://github.com/christophsax/seasonalview/blob/master/R/viewer.R

 .GlobalEnv$.model.passed.to.shiny <- m
# should be 
 .GlobalEnv$.model.passed.to.shiny <- x