checkX13: Check Installation of X-13ARIMA-SEATS

View source: R/checkX13.R

checkX13R Documentation

Check Installation of X-13ARIMA-SEATS

Description

Check the installation of the binary executables of X-13ARIMA-SEATS. See seasonal() for details on how to set X13_PATH manually if you intend to use your own binaries.

Usage

checkX13(fail = FALSE, fullcheck = TRUE, htmlcheck = TRUE)

Arguments

fail

logical, whether an error should interrupt the process. If FALSE, a message is returned.

fullcheck

logical, whether a full test should be performed. Runs Testairline.spc (which is shiped with X-13ARIMA-SEATS) to test the working of the binaries. Returns a message.

htmlcheck

logical, whether the presence of the the HTML version of X-13 should be checked.

Examples

old.path <- Sys.getenv("X13_PATH")
Sys.setenv(X13_PATH = "")  # its broken now
try(checkX13())

# fix it (provided it worked in the first place)
if (old.path == "") {
  Sys.unsetenv("X13_PATH")
} else {
  Sys.setenv(X13_PATH = old.path)
}
try(checkX13())

seasonal documentation built on April 18, 2022, 9:06 a.m.