feat(search): basket mode for cog_gov_search() #1

Merged
jared merged 12 commits from feat/cog-gov-search-basket-mode into main 2026-04-28 15:09:44 -04:00
2 changed files with 74 additions and 68 deletions
Showing only changes of commit ae04d4f48f - Show all commits
+74
View File
@@ -0,0 +1,74 @@
# R/basket.R
#
# Internals supporting the basket-mode sidecar (constructed in
# .resolve_basket() — see R/search.R) plus the user-facing accessors
# cog_basket_resolution() and cog_basket_unresolved() (added in a
# later step).
# Build the sidecar tibble. One row per input; carries query_*, status,
# match_method, canonical_govid, gov_name, n_candidates, and a list-col
# `candidates` of full-schema match-candidate tibbles.
#' @noRd
.build_sidecar <- function(args, resolved) {
type_label <- unname(vapply(args$type, function(t) {
if (is.na(t)) NA_character_ else .type_to_label(t)
}, character(1)))
status <- vapply(resolved, `[[`, character(1), "status")
method <- vapply(resolved, `[[`, character(1), "match_method")
ncand <- vapply(resolved, `[[`, integer(1), "n_candidates")
govid <- vapply(resolved, function(r) {
if (nrow(r$row) == 0L) NA_character_ else r$row$canonical_govid[1L]
}, character(1))
gname <- vapply(resolved, function(r) {
if (nrow(r$row) == 0L) NA_character_ else r$row$gov_name[1L]
}, character(1))
cands <- lapply(resolved, `[[`, "candidates")
tibble::tibble(
query_name = args$name,
query_state = args$state,
query_type = type_label,
status = status,
match_method = method,
canonical_govid = govid,
gov_name = gname,
n_candidates = ncand,
candidates = cands
)
}
# Convert a type input (integer-like or label) into the canonical label
# string used in the sidecar query_type column.
#' @noRd
.type_to_label <- function(type) {
int_type <- .coerce_type(type)
unname(c("0" = "state", "1" = "county", "2" = "city", "3" = "township")[[as.character(int_type)]])
}
# Single post-resolution summary message. Silent on clean baskets;
# emits one cli_inform with two-line body otherwise.
#' @noRd
.basket_summary_message <- function(sidecar) {
status <- sidecar$status
n_input <- length(status)
n_basket <- sum(status %in% c("resolved", "largest_pop"))
n_amb <- sum(status == "ambiguous")
n_nm <- sum(status == "no_match")
n_lp <- sum(status == "largest_pop")
if (n_amb == 0L && n_nm == 0L && n_lp == 0L) return(invisible(NULL))
parts <- c(
if (n_amb > 0L) sprintf("%d ambiguous", n_amb),
if (n_nm > 0L) sprintf("%d with no match", n_nm),
if (n_lp > 0L) sprintf("%d used largest-population fallback", n_lp)
)
cli::cli_inform(c(
i = sprintf("Basket resolved %d of %d entries.", n_basket, n_input),
i = paste(parts, collapse = ", "),
i = "Inspect with `cog_basket_resolution(result)` or filter to problem rows with `cog_basket_unresolved(result)`."
))
invisible(NULL)
}
-68
View File
@@ -306,71 +306,3 @@ cog_gov_search <- function(name = NULL, state = NULL, type = NULL) {
.basket_summary_message(sidecar)
basket
}
# Build the sidecar tibble. One row per input; carries query_*, status,
# match_method, canonical_govid, gov_name, n_candidates, and a list-col
# `candidates` of full-schema match-candidate tibbles.
#' @noRd
.build_sidecar <- function(args, resolved) {
type_label <- unname(vapply(args$type, function(t) {
if (is.na(t)) NA_character_ else .type_to_label(t)
}, character(1)))
status <- vapply(resolved, `[[`, character(1), "status")
method <- vapply(resolved, `[[`, character(1), "match_method")
ncand <- vapply(resolved, `[[`, integer(1), "n_candidates")
govid <- vapply(resolved, function(r) {
if (nrow(r$row) == 0L) NA_character_ else r$row$canonical_govid[1L]
}, character(1))
gname <- vapply(resolved, function(r) {
if (nrow(r$row) == 0L) NA_character_ else r$row$gov_name[1L]
}, character(1))
cands <- lapply(resolved, `[[`, "candidates")
tibble::tibble(
query_name = args$name,
query_state = args$state,
query_type = type_label,
status = status,
match_method = method,
canonical_govid = govid,
gov_name = gname,
n_candidates = ncand,
candidates = cands
)
}
# Convert a type input (integer-like or label) into the canonical label
# string used in the sidecar query_type column.
#' @noRd
.type_to_label <- function(type) {
int_type <- .coerce_type(type)
c("0" = "state", "1" = "county", "2" = "city", "3" = "township")[[as.character(int_type)]]
}
# Single post-resolution summary message. Silent on clean baskets;
# emits one cli_inform with two-line body otherwise.
#' @noRd
.basket_summary_message <- function(sidecar) {
status <- sidecar$status
n_input <- length(status)
n_basket <- sum(status %in% c("resolved", "largest_pop"))
n_amb <- sum(status == "ambiguous")
n_nm <- sum(status == "no_match")
n_lp <- sum(status == "largest_pop")
if (n_amb == 0L && n_nm == 0L && n_lp == 0L) return(invisible(NULL))
parts <- c(
if (n_amb > 0L) sprintf("%d ambiguous", n_amb),
if (n_nm > 0L) sprintf("%d with no match", n_nm),
if (n_lp > 0L) sprintf("%d used largest-population fallback", n_lp)
)
cli::cli_inform(c(
i = sprintf("Basket resolved %d of %d entries.", n_basket, n_input),
i = paste(parts, collapse = ", "),
i = "Inspect with `cog_basket_resolution(result)` or filter to problem rows with `cog_basket_unresolved(result)`."
))
invisible(NULL)
}