feat: export cog_basket_resolution() and cog_basket_unresolved()
Sidecar accessors for basket-mode results. cog_basket_resolution() returns the full resolution tibble (drops candidates list-col by default for readable printing). cog_basket_unresolved() filters to ambiguous/no_match rows for iterative refinement.
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/basket.R
|
||||
\name{cog_basket_resolution}
|
||||
\alias{cog_basket_resolution}
|
||||
\title{Inspect basket-mode resolution sidecar}
|
||||
\usage{
|
||||
cog_basket_resolution(x, expand_candidates = FALSE)
|
||||
}
|
||||
\arguments{
|
||||
\item{x}{A tibble returned by basket-mode [cog_gov_search()].}
|
||||
|
||||
\item{expand_candidates}{Logical. If `TRUE`, keeps the `candidates`
|
||||
list-column (full-schema match candidates per input row). Default
|
||||
`FALSE`.}
|
||||
}
|
||||
\value{
|
||||
A tibble with the resolution audit trail.
|
||||
}
|
||||
\description{
|
||||
Returns the resolution tibble attached to a basket-mode result of
|
||||
[cog_gov_search()]. One row per input entry; `status` is one of
|
||||
`"resolved"`, `"largest_pop"`, `"ambiguous"`, `"no_match"`. By default
|
||||
the `candidates` list-column is dropped for readable printing; pass
|
||||
`expand_candidates = TRUE` to keep it.
|
||||
}
|
||||
Reference in New Issue
Block a user