🦙 Misc changes cos of lintr

Author: francisbarton

R/get_postcode_data.R

@@ -18,14 +18,14 @@
 #' @export
 get_postcode_data <- function(x, as_list = FALSE, include_codes = TRUE) {
   x <- unique(toupper(purrr::discard(x, is.na)))
-  assertthat::assert_that(length(x) > 0, msg = "No postcodes have been found.")
+  assertthat::assert_that(length(x) > 0L, msg = "No postcodes have been found.")
 
   valid_index <- purrr::map_lgl(x, validate_code, .progress = "Checking codes")
   valid_codes <- x[valid_index]
   invalid_codes <- x[!valid_index]
 
   if (length(invalid_codes) > 0L) {
-    inv <- cli::cli_vec(invalid_codes, list(`vec-trunc` = 5))
+    inv <- cli::cli_vec(invalid_codes, list(`vec-trunc` = 5L)) # nolint
     paste0(
       "{.fn get_postcode_data} found {length(invalid_codes)} invalid ",
       "postcode{?s}. Example{?s}: {.val {inv}}. You can use ",
@@ -64,7 +64,7 @@ get_postcode_data <- function(x, as_list = FALSE, include_codes = TRUE) {
 #'
 #' @examples
 #' tibble::tibble(
-#'   place = paste0("place_", 1:3),
+#'   place = paste0("place_", seq(3L)),
 #'   postcode = c("NP22 3PS", "NP22 4PS", "NP22 5PS")
 #' ) |>
 #'   postcode_data_join()
@@ -78,17 +78,15 @@ postcode_data_join <- function(tbl, .col = "postcode", include_codes = TRUE) {
   dplyr::left_join(tbl, api_data, by = dplyr::join_by({{ .col }} == "postcode"))
 }
 
-
-#' Unnest codes (wider): from a list-col to a column each
-#' @param tbl A data frame with ONS (etc.) codes data in a list-col
-#' @keywords internal
-unnest_codes <- function(tbl) {
-  tbl |>
-    dplyr::mutate(codes_names = names(.data[["codes"]])) |>
-    dplyr::mutate(dplyr::across("codes", unlist)) |>
-    tidyr::pivot_wider(
-      names_from = "codes_names",
-      names_glue = "{codes_names}_code",
-      values_from = "codes"
-    )
+tibblise_results_list <- function(results_list) {
+  results_list |>
+    purrr::map("result") |>
+    purrr::list_flatten() |>
+    purrr::map("result") |>
+    purrr::map(purrr::compact) |>
+    # If result contains nested codes then flatten these out and rename.
+    # Hopefully this doesn't break things if codes are not included!
+    purrr::map(\(x) purrr::list_flatten(x, name_spec = "{inner}_code")) |>
+    purrr::map(tibble::as_tibble_row) |>
+    purrr::list_rbind()
 }

man/postcode_data_join.Rd

@@ -3,8 +3,8 @@ test_that("basic test of functions", {
   codes <- c("NP22 3PS", "NP22 4PS", "NP22 5PS")
   out1 <- get_postcode_data(codes) |>
     expect_no_error()
-  expect_equal(out1[["incode"]], c("3PS", "4PS", "5PS"))
-  expect_equal(
+  expect_identical(out1[["incode"]], c("3PS", "4PS", "5PS"))
+  expect_identical(
     # why test this? Just because
     out1[["admin_ward"]],
     c("Tredegar", "Sirhowy", "Moriah and Pontlottyn")
@@ -13,26 +13,26 @@ test_that("basic test of functions", {
 
   out2 <- get_postcode_data(codes, include_codes = FALSE) |>
     expect_no_error()
-  expect_equal(out2[["incode"]], c("3PS", "4PS", "5PS"))
-  expect_length(out2, 23L)
+  expect_identical(out2[["incode"]], c("3PS", "4PS", "5PS"))
+  expect_length(out2, 20L)
 
-  codes_df <- tibble::tibble(place = paste0("place_", 1:3), postcode = codes)
+  codes_df <- tibble::tibble(code = paste0("code_", seq(3L)), postcode = codes)
   out3 <- postcode_data_join(codes_df) |>
     expect_no_error()
-  codes_df <- tibble::tibble(place = paste0("place_", 1:3), codes = codes)
+  codes_df <- tibble::tibble(code = paste0("code_", seq(3L)), codes = codes)
   out4 <- postcode_data_join(codes_df, .col = "codes") |>
     expect_no_error()
   out5 <- postcode_data_join(codes_df, .col = "codes", include_codes = FALSE) |>
     expect_no_error()
-  expect_equal(nrow(out3), 3)
-  expect_equal(nrow(out4), 3)
+  expect_identical(nrow(out3), 3L)
+  expect_identical(nrow(out4), 3L)
   expect_length(out4, 38L)
-  expect_length(out5, 24L)
-  expect_false(any(is.na(out1[["ccg"]])))
-  expect_false(any(is.na(out2[["parish"]])))
-  expect_false(any(is.na(out3[["nuts"]])))
-  expect_false(any(is.na(out4[["longitude"]])))
-  expect_false(any(is.na(out5[["lsoa"]])))
+  expect_length(out5, 21L)
+  expect_false(anyNA(out1[["ccg"]]))
+  expect_false(anyNA(out2[["parish"]]))
+  expect_false(anyNA(out3[["nuts"]]))
+  expect_false(anyNA(out4[["longitude"]]))
+  expect_false(anyNA(out5[["lsoa"]]))
 
   expect_message(get_postcode_data("NP22 3PQ"))
 })

tests/testthat/test-get_postcode_data.R

@@ -8,7 +8,7 @@ test_that("core request function works", {
     httr2::req_user_agent("github.com/nhs-r-community // httr2") |>
     httr2::req_url_path_append(x)
   expect_s3_class(req2, "httr2_request")
-  expect_equal(req2[["url"]], "https://api.postcodes.io/postcodes")
+  expect_identical(req2[["url"]], "https://api.postcodes.io/postcodes")
 })
 
 
@@ -47,16 +47,16 @@ test_that("check terminated function works", {
   out3 <- check_terminated_possibly(pc3) |>
     expect_no_error()
   expect_true(rlang::is_list(out1))
-  expect_length(out1, 5)
+  expect_length(out1, 5L)
   expect_null(out2)
   expect_null(out3)
 })
 
 
 test_that("incomplete postcodes logic", {
   to_incomplete <- \(x) sub("([0-9])([[:alpha:]])[[:alpha:]]?$", "\\1\\2", x)
-  expect_equal(to_incomplete("NP22 3PS"), "NP22 3P")
-  expect_equal(to_incomplete("NP22 3P"), "NP22 3P")
+  expect_identical(to_incomplete("NP22 3PS"), "NP22 3P")
+  expect_identical(to_incomplete("NP22 3P"), "NP22 3P")
 
   code <- "NP22 3P"
   out <- base_request() |>
@@ -65,10 +65,10 @@ test_that("incomplete postcodes logic", {
     pluck_result() |>
     expect_no_error()
   expect_true(rlang::is_list(out))
-  set.seed(4567)
+  set.seed(4567L)
   out2 <- autocomplete_possibly(code)
-  expect_equal(out2, "NP22 3PD")
+  expect_identical(out2, "NP22 3PD")
   out3 <- autocomplete_possibly("NP22 3M") |> # no postcodes exist
     expect_no_error()
-  expect_null(out3)
+  expect_true(is.na(out3))
 })