Update x13 spec with outliers — update_spec

Update an x13_spec output object with outliers from an x13 output object.

Usage

update_spec_outliers(
  sa,
  spec = NULL,
  day = "01",
  verbose = FALSE,
  input_output = is.null(spec)
)

update_outliers(sa, spec, day = "01", null_when_no_new = TRUE, verbose = FALSE)

Arguments

sa: An x13 output object
spec: An x13_spec output object
day: Day of month as character to be used in outlier coding
verbose: Printing information to console when TRUE.
input_output: When TRUE output is a list of x13_spec parameters instead of an updated spec.
null_when_no_new: Whether to return NULL when no new outliers found.

Value

update_spec_outliers returns an updated x13_spec output object with new outliers and updated outlier.from. update_outliers returns a data frame with outlier variables used to update.

Note

For special use, parameter sa to update_outliers can be a data frame of outliers (as created by corona_outliers).

Examples

myseries <- pickmdl_data("myseries")

spec_1 <- rjd3x13::x13_spec("rsa3")
spec_1 <- rjd3toolkit::set_transform(spec_1, fun = "Log")
spec_1 <- rjd3toolkit::set_outlier(spec_1, critical.value =3)
spec_1 <- rjd3toolkit::add_outlier(spec_1, type="AO",date="2008-09-01")


spec_2 <- rjd3toolkit::set_basic(spec_1, type="To", d1 = "2020-02-01")

a <- rjd3x13::x13(myseries, spec_2)

update_outliers(a, spec_1)
#>   type       date
#> 2   LS 2005-11-01
#> 3   TC 2011-06-01
#> 4   AO 2016-03-01

spec_3 <- update_spec_outliers(a, spec_1)

update_spec_outliers(a)
#> $outlier.from
#> [1] "2020-02-01"
#> 
#> $type
#> [1] "AO" "LS" "TC" "AO"
#> 
#> $date
#> [1] "2008-09-01" "2005-11-01" "2011-06-01" "2016-03-01"
#>