tests/testthat/test-CalculateTimeUncertaintyTF.R

In EarthSystemDiagnostics/proxysnr: Separate Signal and Noise in Climate Proxy Records

test_that("CalculateTimeUncertaintyTF runs as expected", {

  skip_if_not_installed("simproxyage", minimum_version = "0.1.1")

  m <- "`df.log` must be of length 1 or `NULL`."
  expect_error(
    suppressMessages(
      CalculateTimeUncertaintyTF(nc = 3, acp = c(90, 50),
                                 df.log = c(0.05, 0.05))
    ), m, fixed = TRUE)

  suppressMessages(
    actual <- CalculateTimeUncertaintyTF(nc = 3, acp = c(100, 50))
  )

  # OBS! To do the test here for nc = 3 is necessary since the function's
  # default of nc = 1 produces an error; see
  # <https://github.com/EarthSystemDiagnostics/simproxyage/issues/1>
  # Adjust this test once that bug is fixed.
  # Also setting the acp manually here is necessary to avoid warnings, see same
  # issue.

  expect_true(is.spectrum(actual))

  nt <- 100
  expect_length(actual$freq, nt / 2)

  suppressMessages(
    actual <- CalculateTimeUncertaintyTF(nc = 3, acp = c(100, 50),
                                         verbose.output = TRUE)
  )

  expect_type(actual, "list")
  expect_length(actual, 3)
  expect_named(actual, c("input", "stack", "ratio"))
  expect_true(is.spectrum(actual$input))
  expect_true(is.spectrum(actual$stack))
  expect_true(is.spectrum(actual$ratio))

  expect_equal(lengths(lapply(actual, "[[", "freq"), use.names = FALSE),
               rep(nt / 2, 3))

  # check attributes
  actualAttr <- attributes(actual$input)
  expect_named(actualAttr,
               c("names", "class", "version", "N.sim",
                 "model", "rate", "log-smooth"))
  expect_true(class(actual$ratio) == "spec")
  expect_true(startsWith(actualAttr$version, "Creation date:"))
  expect_equal(actualAttr$N.sim, "Number of simulations used: N = 100.")
  expect_equal(actualAttr$model, "Process model used: `poisson`.")
  expect_equal(actualAttr$rate, "Process rate used: 0.050.")
  expect_equal(actualAttr$`log-smooth`, "Log-smooth applied: No.")

  expect_equal(actualAttr, attributes(actual$stack))
  expect_equal(actualAttr[c("class", "version", "N.sim",
                            "model", "rate", "log-smooth")],
               attributes(actual$ratio)[c("class", "version", "N.sim",
                                          "model", "rate", "log-smooth")])

  # test with smoothing
  suppressMessages(
    actual <- CalculateTimeUncertaintyTF(nc = 3, acp = c(100, 50),
                                         df.log = 0.05, verbose.output = TRUE)
  )

  expect_type(actual, "list")
  expect_length(actual, 3)
  expect_named(actual, c("input", "stack", "ratio"))
  expect_true(is.spectrum(actual$input))
  expect_true(is.spectrum(actual$stack))
  expect_true(is.spectrum(actual$ratio))
  expect_equal(lengths(lapply(actual, "[[", "freq"), use.names = FALSE),
               rep(nt / 2, 3))
  expect_equal(attr(actual$ratio, "log-smooth"),
               "Log-smooth applied: Yes (df.log = 0.05).")

  # test deprecated function name
  expect_warning(
    suppressMessages(
      actual.depr <- TimeUncertaintyTF(nc = 3, acp = c(100, 50))
    )
  )
  expect_equal(lapply(actual, "[[", "freq"), lapply(actual.depr, "[[", "freq"))

})