tests/testthat/test_08_normals.R

In weathercan: Download Weather Data from Environment and Climate Change Canada

context("Climate Normals")


# normals_html() ------------------------------------------------------------

vcr::use_cassette("normals_html_5010480_1981", {
  test_that("normals_html() correctly retrieves request 1981-2010", {
    skip_on_cran()
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1981-2010", prov = "MB"))
    expect_is(nd, "response")
    expect_false(httr::http_error(nd))
    expect_gt(length(nd$content), 10000)
  })
}, preserve_exact_body_bytes = TRUE)

vcr::use_cassette("normals_html_5010480_1971", {
  test_that("normals_html() correctly retrieves request 1971-2000", {
    skip_on_cran()
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1971-2000", prov = "MB"))
    expect_is(nd, "response")
    expect_false(httr::http_error(nd))
    expect_gt(length(nd$content), 10000)
  })
})

# Proper error when 404
vcr::use_cassette("normals_http404", {
  memoise::forget(normals_html) # Reset cache so we can test a different url
  test_that("normals_html() errors", {
    skip_on_cran()
    bkup <- getOption("weathercan.urls.normals")
    options(weathercan.urls.normals = "https://httpstat.us/404")
    expect_error(normals_html(prov = "MB", station_id = 3471,
                              climate_id = "5010480",
                              normals_years = "1981-2010"),
                 "Failed to access",
                 class = "http_error")
    options(weathercan.urls.normals = bkup)
  })
})


# normals_raw() -------------------------------------------------------------
test_that("normals_raw() extracts normals as character", {
  skip_on_cran()
  #1981
  vcr::use_cassette("normals_html_5010480_1981", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1981-2010", prov = "MB"))
  })

  expect_silent(nd <- normals_raw(nd)) %>%
    expect_is("character")
  expect_false(any(stringr::str_detect(nd, "[^\001-\177]")))


  #1971
  vcr::use_cassette("normals_html_5010480_1971", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1971-2000", prov = "MB"))
  })

  expect_silent(nd <- normals_raw(nd)) %>%
    expect_is("character")
  expect_false(any(stringr::str_detect(nd, "[^\001-\177]")))

})


# normals_extract() ---------------------------------------------------------
test_that("normals_extract() cleans up raw data", {
  skip_on_cran()
  #1981-2010
  vcr::use_cassette("normals_html_5010480_1981", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1981-2010", prov = "MB"))
  })

  n <- normals_raw(nd)

  expect_silent(n1 <- normals_extract(n)) %>%
    expect_is("character")
  expect_lt(length(n1), length(n))
  expect_true(stringr::str_detect(n1[1], "Jan"))

  #1971-2000
  vcr::use_cassette("normals_html_5010480_1971", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1971-2000", prov = "MB"))
  })

  n <- normals_raw(nd)

  expect_silent(n1 <- normals_extract(n)) %>%
    expect_is("character")
  expect_lt(length(n1), length(n))
  expect_true(stringr::str_detect(n1[1], "Jan"))
})


# data/frost_extract() ----------------------------------------------------
test_that("data_extract() / frost_extract() extract data", {
  skip_on_cran()
  # 1981-2010
  vcr::use_cassette("normals_html_5010480_1981", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1981-2010", prov = "MB"))
  })

  n <- nd %>%
    normals_raw() %>%
    normals_extract()

  expect_silent(data_extract(n, climate_id = "5010480")) %>%
    expect_is("data.frame")
  expect_silent(frost_extract(n, climate_id = "5010480")) %>%
    expect_is("data.frame")


  # 1971-2000
  vcr::use_cassette("normals_html_5010480_1971", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1971-2000", prov = "MB"))
  })

  n <- nd %>%
    normals_raw() %>%
    normals_extract()

  expect_silent(data_extract(n, climate_id = "5010480")) %>%
    expect_is("data.frame")
  expect_silent(frost_extract(n, climate_id = "5010480")) %>%
    expect_is("data.frame")

})


# normals_format/frost_format ---------------------------------------------
test_that("normals_format()/frost_format() format data to correct class", {
  skip_on_cran()
  # 1981-2010
  vcr::use_cassette("normals_html_5010480_1981", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1981-2010", prov = "MB"))
  })

  n <- nd %>%
    normals_raw() %>%
    normals_extract()

  expect_silent(f <- frost_extract(n, climate_id = "5010480"))
  expect_silent(n <- data_extract(n, climate_id = "5010480"))

  expect_silent(n_fmt <- data_format(n)) %>%
    expect_is("data.frame")
  expect_is(n_fmt[["temp_daily_average"]], "numeric")
  expect_is(n_fmt[["temp_extreme_max_date"]], "Date")
  expect_is(n_fmt[["wind_dir"]], "character")

  expect_silent(f_fmt <- frost_format(f)) %>%
    expect_is("data.frame")
  expect_is(f_fmt[["date_first_fall_frost"]], "numeric")
  expect_is(f_fmt[["prob_first_fall_temp_below_0_on_date"]], "numeric")
  expect_is(f_fmt[["frost_code"]], "character")


  # 1971-2000
  vcr::use_cassette("normals_html_5010480_1971", {
    expect_silent(nd <- normals_html(station_id = 3471, climate_id = "5010480",
                                     normals_years = "1971-2000", prov = "MB"))
  })

  n <- nd %>%
    normals_raw() %>%
    normals_extract()

  expect_silent(f <- frost_extract(n, climate_id = "5010480"))
  expect_silent(n <- data_extract(n, climate_id = "5010480"))

  expect_silent(n_fmt <- data_format(n)) %>%
    expect_is("data.frame")
  expect_is(n_fmt[["temp_daily_average"]], "numeric")
  expect_is(n_fmt[["temp_extreme_max_date"]], "Date")
  expect_is(n_fmt[["wind_dir"]], "character")

  expect_silent(f_fmt <- frost_format(f)) %>%
    expect_is("data.frame")
  expect_is(f_fmt[["date_first_fall_frost"]], "NULL")
  expect_is(f_fmt[["prob_first_fall_temp_below_0_on_date"]], "NULL")
  expect_is(f_fmt[["frost_code"]], "NULL")
})


# normals_dl() ------------------------------------------------------------
test_that("normals_dl() downloads normals/frost dates as tibble - single", {
  skip_on_cran()
  # 1981-2010
  vcr::use_cassette("normals_dl_5010480_1981", {
    expect_silent(nd <- normals_dl(climate_id = "5010480")) %>%
      expect_is("tbl_df")
  })

  # 1971-2000
  vcr::use_cassette("normals_dl_5010480_1971", {
    expect_silent(nd <- normals_dl(climate_id = "5010480",
                                   normals_years = "1971-2000")) %>%
      expect_is("tbl_df")
  })
})

vcr::use_cassette("normals_dl_1096450_2403500_5010480_1981", {
  test_that("normals_dl() downloads normals/frost dates as tibble - multi 1981", {
    skip_on_cran()
    expect_silent(nd <- normals_dl(climate_id = c("2403500", "5010480",
                                                  "1096450"))) %>%
      expect_is("tbl_df")

    expect_equal(nrow(nd), 3)
    expect_is(tidyr::unnest(nd, normals), "data.frame")
    expect_is(tidyr::unnest(nd, frost), "data.frame")
    expect_length(tidyr::unnest(nd, normals) %>%
                    dplyr::pull(climate_id) %>%
                    unique(), 3)
    expect_length(tidyr::unnest(nd, frost) %>%
                    dplyr::pull(climate_id) %>%
                    unique(), 3)
  })
})

vcr::use_cassette("normals_dl_1096450_2403500_5010480_1971", {
  test_that("normals_dl() downloads normals/frost dates as tibble - multi 1971", {
    skip_on_cran()
    expect_silent(nd <- normals_dl(climate_id = c("2403500", "5010480",
                                                  "1096450"),
                                   normals_years = "1971-2000")) %>%
      expect_is("tbl_df")

    expect_equal(nrow(nd), 3)
    expect_is(tidyr::unnest(nd, normals), "data.frame")
    expect_is(tidyr::unnest(nd, frost), "data.frame")
    expect_length(tidyr::unnest(nd, normals) %>%
                    dplyr::pull(climate_id) %>%
                    unique(), 3)
    expect_length(tidyr::unnest(nd, frost) %>%
                    dplyr::pull(climate_id) %>%
                    unique(), 0)
  })
})

# Bug fixes ------------------------------------------------------------------
# Fix issue #106 - Added (C) to extreme wind chill
vcr::use_cassette("normals_dl_2100517_1981", {
  test_that("normals_dl() gets extreme wind chill correctly", {
    skip_on_cran()
    expect_silent(nd <- normals_dl(climate_id = "2100517")) %>%
      expect_is("tbl_df")
  })
})